Documentation for the Endless Access community itself. Uses Just the Docs.
Documentation is stored as Markdown files in this repository, either in the root or in subfolders. The file's path determines the URL of the page; for example:
index.md
architecture/
├─ index.md
├─ platforms.md
becomes:
/
/architecture/
/architecture/platforms/
To make a page show as a child page (e.g. in the sidebar), include parent by title (case-sensitive) in the Front Matter, e.g.:
parent: Architecture
For more information, see the Page Levels documentation.
Images are stored in the assets/images/ folder, which should be kept organized with sensible names and paths to make it easy to find and reuse images. To include an image in a page, use standard Markdown syntax with a relative path from the Markdown file. e.g. in a file architecture/platforms.md, you could use:
The site uses a lightly-customized theme to better align with the Endless Access brand and support a dark style while still benefitting from future updates from Just the Docs. Changes mostly just include typography and color variables.
Sass variable overrides and new definitions are in _sass/custom/setup.scss. Style class overrides are in _sass/custom/custom.scss.
The custom dark style is defined in _sass/color_schemes/ea-dark.scss and is applied via Javascript based on the OS/browser's style in _includes/js/custom.js. Proper support for OS/browser dark style is being tracked upstream at just-the-docs/just-the-docs#234.
Assuming Jekyll and Bundler are installed on your computer:
-
Change your working directory to the root directory of your site.
-
Run
bundle install. -
Run
bundle exec jekyll serveto build your site and preview it atlocalhost:4000.The built site is stored in the directory
_site.