Giter VIP home page Giter VIP logo

site-docs's Introduction

The Temple Operating System

โš”๏ธ TempleOS Simplified ๐Ÿ“–

Discord Invite Website

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

Contributors

site-docs's People

Contributors

nrootconauto avatar hututudor avatar imgbotapp avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.