https://github.com/sudo88com/docs
Documentation Site
https://github.com/sudo88com/docs
docs docusaurus github-pages
Last synced: about 1 year ago
JSON representation
Documentation Site
- Host: GitHub
- URL: https://github.com/sudo88com/docs
- Owner: sudo88com
- License: mit
- Created: 2024-06-24T14:01:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-07T01:45:53.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T14:47:47.580Z (about 1 year ago)
- Topics: docs, docusaurus, github-pages
- Language: JavaScript
- Homepage: https://sudo88com.github.io/docs/
- Size: 355 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Website
[](https://github.com/sudo88com/docs/actions/workflows/deploy_github_pages.yml)
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
The site is automatically deployed using GitHub Actions. The output is available at [https://sudo88com.github.io/docs/Intro/](https://sudo88com.github.io/docs/Intro/).
### Local Development
The website is set up to use GitHub Actions for continuous integration and deployment. To run the website locally for development, follow these steps:
1. **Clone the Repository**:
```bash
$ git clone https://github.com/sudo88com/docs.git
$ cd docs
```
2. **Install Dependencies**:
```bash
$ npm install
```
3. **Start the Development Server**:
```bash
$ npm start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
To generate the static content for the website:
```bash
$ npm run build
```
This command creates static content in the `build` directory, which can be served using any static content hosting service.
# License
This project is licensed under the [MIT License](/LICENSE). See the LICENSE file for details.