Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brilliantlabsar/docs
Technical documentation source pages for all Brilliant products. Check out the live documentation site here:
https://github.com/brilliantlabsar/docs
micropython monocle-ar
Last synced: 20 days ago
JSON representation
Technical documentation source pages for all Brilliant products. Check out the live documentation site here:
- Host: GitHub
- URL: https://github.com/brilliantlabsar/docs
- Owner: brilliantlabsAR
- License: other
- Created: 2022-12-14T12:31:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T16:16:59.000Z (2 months ago)
- Last Synced: 2024-12-10T15:06:44.448Z (29 days ago)
- Topics: micropython, monocle-ar
- Language: Ruby
- Homepage: https://docs.brilliant.xyz
- Size: 23.9 MB
- Stars: 43
- Watchers: 5
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Brilliant Docs - Source
This site is built with [Jekyll](https://jekyllrb.com) and [Just the Docs](https://github.com/just-the-docs/just-the-docs). It's all hosted here on GitHub using the GitHub's [Pages](https://pages.github.com) feature.
**If you spot any errors** in our documentation, feel free to make an [issue](https://github.com/brilliantlabsAR/docs/issues).
If you'd like to do some extensive editing, you can also fork/clone this repository and view the pages live editing.
## To set it up:
1. Ensure you have [Ruby installed](https://www.ruby-lang.org/en/documentation/installation/). On MacOS, ruby is already installed and ready to go.
1. Clone this repository:
```bash
git clone https://github.com/brilliantlabsAR/docs.git
```
1. Set up the environment:
```bash
cd docs
bundle install
```
1. Open the project in your browser:
```bash
bundle exec jekyll serve --livereload --open-url
```
That's it! As you edit the pages. The website will automatically refresh. Be sure to keep an eye on your terminal to spot any error messages while you're developing.