https://github.com/os-1337/docs

OS/1337 Documentation
https://github.com/os-1337/docs

Last synced: about 1 month ago
JSON representation

OS/1337 Documentation

• Host: GitHub
• URL: https://github.com/os-1337/docs
• Owner: OS-1337
• License: other
• Created: 2024-07-20T18:05:04.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-20T20:09:34.000Z (5 months ago)
• Last Synced: 2024-07-21T19:59:18.299Z (5 months ago)
• Language: JavaScript
• Size: 1.35 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
#	OS/1337 Documentation

###	A easy to use documentation for OS/1337

## Visit [docs.os1337.com](https://docs.os1337.com) to read.

---

##	Why?

Because making more accessible and easy to search documentation for OS/1337 will make it easier to:

- Use OS/1337

- Build OS/1337 from scratch

  - including reproducible builds

- Port applications to OS/1337

- Make it easier to use OS/1337

##	How does this repo work?

For ease of use, OS/1337 utilizes [MkDocs](https://www.mkdocs.org) as an *"Offline CMS"* that provides and easy to use UI to search and browse the documentation.

- The contents of [```/site/```](./site) are being hosted and offered as webpage reachable under [```docs.os1337.com```](https://docs.os1337.com).

- For ease of editing and also accessibility, the documentation is stored on [```/docs/```](./docs). These are [Markdown](https://en.wikipedia.org/wiki/Markdown)-formatted plaintext files.

-