Skip to content

Commit 8dd0f69

Browse files
Copilotneilime
Copilot
and
neilime
committed
feat: Initialize Docusaurus documentation portal for Hoverkraft
Co-authored-by: neilime <314088+neilime@users.noreply.github.com>
1 parent 5883bde commit 8dd0f69

41 files changed

Lines changed: 19557 additions & 6 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1-
_site/
2-
.sass-cache/
3-
.jekyll-cache/
4-
.jekyll-metadata
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎README.md‎

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,79 @@
1-
# public-docs
2-
Public documentation for hoverkraft open-source projects (aka openkraft)
1+
# Hoverkraft Documentation Portal
2+
3+
Public documentation portal for Hoverkraft open-source projects (aka openkraft).
4+
5+
This repository contains the source code for the Hoverkraft documentation website built with [Docusaurus](https://docusaurus.io/).
6+
7+
## 🚀 Quick Start
8+
9+
### Prerequisites
10+
11+
- Node.js 20.0 or higher
12+
- npm
13+
14+
### Installation
15+
16+
```bash
17+
npm install
18+
```
19+
20+
### Development
21+
22+
Start the development server:
23+
24+
```bash
25+
npm start
26+
```
27+
28+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
29+
30+
### Build
31+
32+
```bash
33+
npm run build
34+
```
35+
36+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
37+
38+
### Deployment
39+
40+
```bash
41+
npm run deploy
42+
```
43+
44+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
45+
46+
## 📁 Project Structure
47+
48+
```
49+
├── blog/ # Blog posts
50+
├── docs/ # Documentation pages
51+
├── src/ # Source files (React components, pages, etc.)
52+
│ ├── components/ # React components
53+
│ ├── css/ # CSS files
54+
│ └── pages/ # Additional pages
55+
├── static/ # Static assets
56+
├── docusaurus.config.ts # Docusaurus configuration
57+
└── sidebars.ts # Sidebar configuration
58+
```
59+
60+
## 🛠️ Customization
61+
62+
This portal is designed to dynamically build content from Hoverkraft's public repositories. The CI workflow will scan repositories and build the portal using:
63+
64+
- Repository topics and descriptions
65+
- Social preview images
66+
- README files and documentation
67+
- Other useful metadata
68+
69+
## 📝 Contributing
70+
71+
1. Fork the repository
72+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
73+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
74+
4. Push to the branch (`git push origin feature/amazing-feature`)
75+
5. Open a Pull Request
76+
77+
## 📄 License
78+
79+
This project is part of the Hoverkraft open-source ecosystem.

‎blog/2019-05-28-first-blog-post.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
slug: first-blog-post
3+
title: First Blog Post
4+
authors: [slorber, yangshun]
5+
tags: [hola, docusaurus]
6+
---
7+
8+
Lorem ipsum dolor sit amet...
9+
10+
<!-- truncate -->
11+
12+
...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

‎blog/2019-05-29-long-blog-post.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
slug: long-blog-post
3+
title: Long Blog Post
4+
authors: yangshun
5+
tags: [hello, docusaurus]
6+
---
7+
8+
This is the summary of a very long blog post,
9+
10+
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
11+
12+
<!-- truncate -->
13+
14+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15+
16+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17+
18+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19+
20+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21+
22+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23+
24+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25+
26+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27+
28+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29+
30+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31+
32+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33+
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35+
36+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37+
38+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39+
40+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43+
44+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

‎blog/2021-08-01-mdx-blog-post.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
slug: mdx-blog-post
3+
title: MDX Blog Post
4+
authors: [slorber]
5+
tags: [docusaurus]
6+
---
7+
8+
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
9+
10+
:::tip
11+
12+
Use the power of React to create interactive blog posts.
13+
14+
:::
15+
16+
{/* truncate */}
17+
18+
For example, use JSX to create an interactive button:
19+
20+
```js
21+
<button onClick={() => alert('button clicked!')}>Click me!</button>
22+
```
23+
24+
<button onClick={() => alert('button clicked!')}>Click me!</button>

‎blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg‎

93.9 KB
Loading

‎blog/2021-08-26-welcome/index.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
slug: welcome
3+
title: Welcome
4+
authors: [slorber, yangshun]
5+
tags: [facebook, hello, docusaurus]
6+
---
7+
8+
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
9+
10+
Here are a few tips you might find useful.
11+
12+
<!-- truncate -->
13+
14+
Simply add Markdown files (or folders) to the `blog` directory.
15+
16+
Regular blog authors can be added to `authors.yml`.
17+
18+
The blog post date can be extracted from filenames, such as:
19+
20+
- `2019-05-30-welcome.md`
21+
- `2019-05-30-welcome/index.md`
22+
23+
A blog post folder can be convenient to co-locate blog post images:
24+
25+
![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
26+
27+
The blog supports tags as well!
28+
29+
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

‎blog/authors.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
yangshun:
2+
name: Yangshun Tay
3+
title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
4+
url: https://linkedin.com/in/yangshun
5+
image_url: https://github.com/yangshun.png
6+
page: true
7+
socials:
8+
x: yangshunz
9+
linkedin: yangshun
10+
github: yangshun
11+
newsletter: https://www.greatfrontend.com
12+
13+
slorber:
14+
name: Sébastien Lorber
15+
title: Docusaurus maintainer
16+
url: https://sebastienlorber.com
17+
image_url: https://github.com/slorber.png
18+
page:
19+
# customize the url of the author page at /blog/authors/<permalink>
20+
permalink: '/all-sebastien-lorber-articles'
21+
socials:
22+
x: sebastienlorber
23+
linkedin: sebastienlorber
24+
github: slorber
25+
newsletter: https://thisweekinreact.com

‎blog/tags.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
facebook:
2+
label: Facebook
3+
permalink: /facebook
4+
description: Facebook tag description
5+
6+
hello:
7+
label: Hello
8+
permalink: /hello
9+
description: Hello tag description
10+
11+
docusaurus:
12+
label: Docusaurus
13+
permalink: /docusaurus
14+
description: Docusaurus tag description
15+
16+
hola:
17+
label: Hola
18+
permalink: /hola
19+
description: Hola tag description

‎docs/intro.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Welcome to Hoverkraft Docs
6+
7+
Welcome to the **Hoverkraft documentation portal** - your gateway to our open-source ecosystem.
8+
9+
## What is Hoverkraft?
10+
11+
Hoverkraft (also known as openkraft) is a collection of open-source projects focused on building developer-friendly tools and technologies. Our mission is to create high-quality, well-documented software that empowers developers to build amazing things.
12+
13+
## Getting Started
14+
15+
Explore our projects and find the documentation you need:
16+
17+
### Browse Our Projects
18+
19+
Visit our [GitHub organization](https://github.com/hoverkraft-tech) to see all available projects. Each repository includes:
20+
21+
- 📚 Comprehensive documentation
22+
- 🏷️ Clear topic tags for easy discovery
23+
- 🖼️ Social preview cards for quick understanding
24+
- 📖 Detailed README files
25+
- 🚀 Getting started guides
26+
27+
### Contributing
28+
29+
We welcome contributions from the community! Each project has its own contribution guidelines, but generally:
30+
31+
1. **Fork** the repository you want to contribute to
32+
2. **Create** a feature branch
33+
3. **Make** your changes with proper documentation
34+
4. **Test** your changes thoroughly
35+
5. **Submit** a pull request
36+
37+
## Documentation Structure
38+
39+
This portal is dynamically built from our repository metadata, including:
40+
41+
- Repository descriptions and topics
42+
- README files and documentation
43+
- Social preview images
44+
- Issue and discussion templates
45+
- Contributing guidelines
46+
47+
## Community
48+
49+
Join our community and stay updated:
50+
51+
- 🐙 [GitHub Organization](https://github.com/hoverkraft-tech)
52+
- 📝 [Project Discussions](https://github.com/orgs/hoverkraft-tech/discussions)
53+
54+
---
55+
56+
*This documentation portal is built with [Docusaurus](https://docusaurus.io/) and automatically updated from our repository metadata.*

0 commit comments

Comments
 (0)