https://github.com/berkeley-cdss/docs
https://github.com/berkeley-cdss/docs
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/berkeley-cdss/docs
- Owner: berkeley-cdss
- License: mit
- Created: 2025-03-05T21:39:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-02T18:31:48.000Z (4 months ago)
- Last Synced: 2026-02-03T08:31:13.761Z (4 months ago)
- Language: SCSS
- Homepage: https://berkeley-cdss.github.io/docs/
- Size: 7.71 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# CDSS Common Documentation
[](https://github.com/berkeley-cdss/docs/actions/workflows/jekyll.yml)
[](https://github.com/berkeley-cdss/docs/actions/workflows/rspec.yml)
## Installation
### Install Ruby and Bundler
**The berkeley-class-site template requires Ruby 3.3.7 or higher and bundler >= 2.6**
Install Ruby before continuing. You can check your Ruby version by running:
```bash
ruby --version
bundle --version
```
Prerequisites:
- You have everything that [Jekyll requires](https://jekyllrb.com/docs/installation/)
- You have installed [Bundler](https://bundler.io/): Run `gem install jekyll bundler`
## Clone the repository and install dependencies
```bash
git clone git@github.com:berkeley-cdss/docs.git
bundle install
```
## Usage
To run the site locally, run:
```bash
cd
bundle exec jekyll serve
```
Note that if you alter `_config.yml`, you will need to rerun the above command to see the changes reflected.
## Deployment
Via [GitHub Pages](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
[MIT](LICENSE)