The official source code powering WeatherXM Docs.
Maintained by WeatherXM - Community contributions encouraged.
$ yarn
$ yarn 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.
Pull requests, opening new issues, discussions, and contributions from the community are encouraged.
Every page uses Markdown syntax which is a lightweight markup language that you can use to add formatting elements to plaintext text documents.
Use the guide found here to learn about the markdown syntax.
For more advanced content consider using JSX.
If you think you have found an issue or just want to initiate a discussion regarding the documentation you can do so by visiting the GitHub Issue Tracker and click the "New Issue" button.
Each page in the documentation has an "Edit this page" link at the bottom of the content. By clicking it you are taken to the relevant GitHub location where this page is located and you can edit it and fix or add anything you think that is needed. Please keep in mind that you need to have a GitHub account and be logged in.
Once logged in, you can use the built-in text editor of GitHub where you can make your edits directly. When you've completed your changes, you can add any specific details on what was changed and commit to a new branch to create a new Pull Request to the repository. Afterwards one of the maintainers will review your changes, and either merge them or request changes.
Create a new *.mdx extension file following the existing naming conventions to the relevant directory.
Also don't forget to update the sidebars.js file and add that new entry there.
We use a plugin called Prettier to format the code. You can run this locally by doingnpx prettier --write . or you can do npx pretty-quick --staged which runs on the changed files of your local copy.
This website is built using Docusaurus 2.