Introduction
- TempleOS Simplified is a community built and operated documentation for learning the in's and out's of the Temple Operating System, along with it's unique C-variant "HolyC".
- TempleOS Simplfied is designed to be as beginner friendly as possible while maintaining a content-rich approach.
- Built using
🦕 Docusaurus; built with elegancy.
Contributing
Note
A basic understanding of React and Markdown may be nesseciary for editing features of TempleOS Simplified.
Upon pushing to the main branch, the site will be automatically built to the gh-pages (Does not require any manual updates; all work is done on the main branch) and deployed to GitHub pages. Understanding the file structure is important to contributing to the site; it may be worth checking out the Docsuaurs Documentation.
File Structure
Editing the documentation pages requires only an understanding of Markdown. These pages can be edited within the docs/ directory, and look something like this:
.
├── getting-started
│ ├── _category_.json
│ ├── Diving In.mdx
│ ├── img
│ │ ├── bootloader.png
│ │ └── terminal.png
│ └── installation.mdx
└── intro.mdx
Images and resources should be added to static/ which is built directly to / in gh-pages:
.
├── CNAME
└── img
├── elephant.svg
├── favicon.ico
├── HolyC_Logo.svg
├── larger.jpg
├── logo.jpg
├── logo_upscaled.jpg
└── terry.svg