This repository was archived by the owner on Apr 13, 2025. It is now read-only.
Add Documentation Guide #79
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add `documentation.md` as a general guide on how to contribute to this repository
- Add `markdown.md` describing our Markdown plugins
- Rename `.ignore-files.txt` to `.prettierignore`
-> Change scripts in `package.json`
- Add `tasks.json` for format, build and serve task
- Add `extensions.json` to recommend some Markdown extensions for VS Code to reflect our mkdocs plugins
- Add `settings.json` to hide false positives caused by admonition and nodecg-io
Tim
Signed-off-by: Tim_Tech_Dev <Tim_Tech_Dev@protonmail.com>
Tim Signed-off-by: Tim_Tech_Dev <Tim_Tech_Dev@protonmail.com>
- Use admonition where applicable
- Use tabs in install.md
- Add sample documentation contribution guidelines
- Fix code span style in install.md
- Add word wrap for code blocks
Tim
Signed-off-by: Tim_Tech_Dev <Tim_Tech_Dev@protonmail.com>
Tim Signed-off-by: Tim_Tech_Dev <Tim_Tech_Dev@protonmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
documentation.mdas a general guide on how to contribute to this repositoryAdd
markdown.mddescribing our Markdown pluginsRename
.ignore-files.txtto.prettierignore-> Change scripts in
package.jsonAdd
tasks.jsonfor format, build and serve taskAdd
extensions.jsonto recommend some Markdown extensions for VS Code to reflect our mkdocs pluginsAdd
settings.jsonto hide false positives caused by admonition and nodecg-ioConsistency changes in the whole docs
Use admonition where applicable
Use tabs in install.md
Add sample documentation contribution guidelines
Fix code span style in install.md
Add word wrap for code blocks
Tim
codeoverflow-org/nodecg-io#37 (comment)