No description
Per Phil. He stated that such documentation should be in markdown on circuitpython.org itself. In this PR, no accompanying images are used. If images are desired, we will need to determine where to put them. Under /assets or under /doc or somewhere else. |
||
|---|---|---|
| .github/workflows | ||
| _blinka | ||
| _board | ||
| _data | ||
| _includes | ||
| _layouts | ||
| adabot@56ccf2c533 | ||
| assets | ||
| awesome-circuitpython@fb372b9804 | ||
| contributing | ||
| doc | ||
| lib/tasks | ||
| libraries | ||
| .gitignore | ||
| .gitmodules | ||
| 404.html | ||
| _config.yml | ||
| awesome.html | ||
| blinka.html | ||
| CNAME | ||
| downloads.html | ||
| Gemfile | ||
| Gemfile.lock | ||
| index.html | ||
| Rakefile | ||
| README.md | ||
| stats.html | ||
| template.md | ||
| trademarks.html | ||
CircuitPython organization site
To add a new board to the site:
- Duplicate
template.mdto_board/<board id>.md. - Edit
_board/<board id>.mdaccording to the template's instructions. - Provide 3 images. An original high-quality image. A smaller image (300 px width), and a larger image (700 px width) in each respective directory (assets/images/boards/{small large original}) and process them in something like https://squoosh.app/ to reduce file size. If you only have one image, place it in the 'original' folder.
- Create a pull request with the file changes.
To test your changes locally:
- You need "ruby" and "ruby-bundler" installed locally. These instructions were tested with ruby 2.5 and ruby-bundler 1.17.3 on a Debian Stretch system.
- As needed,
git submodule update --init --recursiveto fetch the submodules - One time, run
bundle install --path vendor/bundle - Run
bundle exec jekyll serveto generate the site locally - Visit the displayed "server address"
- After most local edits, the content will be updated. You will need to reload (ctrl-r or F5) your browser