This is a documentation site for deid. It is part of the pydicom family of tools.
- Install Jekyll locally. For Ruby, I recommend rbenv.
- Install Jekyll dependencies with
bundle install - To serve the development server run
bundle exec jekyll serve
If you aren't familiar with the structure of a Jekyll site, here is a quick overview:
- _config.yml is the primary configuration file for the site. Variables in this file render as
{{ site.var }}in the various html includes and templates. - _layouts are base html templates for pages
- _includes are snippets of html added to layouts
- pages are generic pages (e.g., changelog) that aren't considered docs
- _docs is a collection of folders that get rendered into the docs sidebar and pages
- assets includes all static assets
- _data has different data files (they can be in
.ymlor.csvto render into the site.