G'day, mates from Top Mello team. Here's our development documentation respository to standardize our tech stack, share our knowledge and keep an consistency across the project. Documenting tech manual, your thoughts and decisions you made here.
Link To TopMello Documentation
Use the following link to learn about writting docs, tags them and organize directories:
How to Create Doc - Docusaurus
Remember to PUSH the changes to Github too after writing
to be continued...
Follow the steps in Contribute Manual which are:
- Installation
- Local Development (for develop and test)
- Deployment (to Github pages)
We use Docusaurus to generate our documentations written in Markdown format.
This requires you to install Node.js version 16 and newer.
After installing Node.js Version 16+, execute the following code within the root directory of the project.
Do NOT include leading "$" when executing the following commands
$ npm install
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ npm run start
Using SSH:
$ USE_SSH=true npm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> npm run deploy
Now you should see changes in topmello.github.io Remember to PUSH the changes to Github too after writing
sudo apt-get install pandoc texlive-latex-base texlive-fonts-recommended texlive-extra-utils texlive-latex-extrapandoc support.md -o support-custom.pdf --pdf-engine=lualatex --highlight-style=kate --template=template.latex