https://github.com/nodecg/docs

Documentation website for NodeCG
https://github.com/nodecg/docs

Last synced: about 14 hours ago
JSON representation

Documentation website for NodeCG

• Host: GitHub
• URL: https://github.com/nodecg/docs
• Owner: nodecg
• Created: 2020-02-28T01:17:51.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T07:20:36.000Z (6 months ago)
• Last Synced: 2024-05-28T14:39:48.763Z (6 months ago)
• Language: TypeScript
• Homepage: https://nodecg.dev
• Size: 17.1 MB
• Stars: 8
• Watchers: 6
• Forks: 12
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Security: docs/security.md

Awesome Lists containing this project

README

        
# NodeCG Docs

These docs are built using [Docusaurus 2](https://v2.docusaurus.io/).

The [Markdown lint tool](https://github.com/DavidAnson/markdownlint) is used for linting.

Some markdown rules have been disabled:

| #                                                                                  | Rule                                      | Why |

|----------------------------------------------------------------------------------- | ----------------------------------------- | --- |

| [MD002](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md002) | First header should be a top level header | First headers are made by Docusaurus [Front matter](https://docusaurus.io/docs/markdown-features#front-matter)  |

| [MD013](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013) | Line length                               |     |

| [MD026](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026) | Trailing punctuation in heading           | Various headings in the NodeCG readme have valid question marks in the header |

| [MD033](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033) | Inline HTML                               | Video tags are used to demonstrate certain concepts |

| [MD051](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md051) | Link fragments should be valid            | Innerpage links done using anchor tags, not following GitHub heading algorithm |

## Installation

```bash

npm install

```

### Local Development

```bash

npm start

```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Build

```bash

npm run build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Internationalization / Translations

We currently are targeting Japanese and French for our translations but if you want to help out and translate it in your own language by all means please do so.

To run a local dev server on a specific translation, run:

```bash

npx docusaurus serve --locale 

# Example for Japanese

npx docusaurus serve --locale ja

```

To edit the translations go into the `i18n` folder and then the language you wish to edit.

Files in the `code.json` file are strings used in React components. (For now some docusaurus elements and the homepage).

To edit documentation open the `docusaurus-plugin-content-docs` folder and copy paste the doc you wish to edit making sure to keep the same folder structure as the normal docs folder. Then just translate and edit the documentation.

**Note:** Do not edit the text in brackets next to headers i.e. the **{#title}** in `#Title {#title}`. These are "Explicit Heading IDs" and exist so that edits to links don't have to occur, [Source](https://docusaurus.io/docs/i18n/tutorial#translate-the-pages).