This is the GitHub repository (source code) for the LanternOS WIKI website where the WIKI for LanternOS is hosted. It is open source under the APACHE 2.0 License.
We are using Docusaurus to generate the documentation website from Markdown (MDX) combined with React for some of the hosted pages.
The GitHub Repository for the LanternOS project can be found here.
If you want to view the source code conveniently without downloading/cloning the repo, you can just go to this link which opens the repo in an environment like that of Visual Studio Code where you can easily study the source code. We are using an open-source project called GitHub1s to power the viewing experience.
In order to run the documentation website locally (on your machine) or another server:
- Just download the source code (i.e. clone the repo from GitHub)
- Make sure you have
npmandnodeinstalled. It should beNode.jsversion >= 12.13.0 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed. - Open a terminal in the root folder of the project and run the command
npm run startwhich will build the source code into a website and serve it onhttps://localhost:3000.
If you want to modify the website/files locally on you machine, just follow the installation instructions. Once installed, you can leave the server running (using npm run start) as each time you change a file, the website automatically rebuilds and refreshes, thus saving you the time of running the start command over and over again, which also takes more time to compile.
If there are issues with the auto re-building of the repo when you make changes, just stop the server and start it again using the same command. Some changes don't show up on the webpage due to caching. The simplest way to solve that problem is to refresh the webpage using the
Ctrl + F5command which force refreshes all the website files.
You can use the resources (documentation) found here in order to understand how docusaurus works and how you can edit the files and various configurations on getting the website to work the way you want it to.
This repo is open source under the APACHE 2.0 License which can be found in the root folder of the Repo.
If you want to contribute to the documentation, do read the contribution guidelines (not yet created).
You need to first fork this repo using your GitHub account and then follow the Installation and Local Development steps.
After making the changes, commit them to the fork you created and then open a pull request into this repo from your repo. Make sure the commit and pull request details all the changes you made. Thank you!
TODO: THIS README IS INCOMPLETE