Features

[NicolasMassart]

Here is a first set of features for this doctools.template-site (checked ones are already implemented).

See also Consensys/doctools.action-builder#4 for Builder features

Themes

• Light and dark themes
• Easy katacoda.com integration (other to come on demand)
• Easy ReDoc REST API doc from a JSON or YAML spec (local or remote).
• Integration for Asciinema
• Integration of Youtube videos
• New consistent branding
• Home pages templates (like landing pages)
• Enable use of custom CSS and JS for each doc site in addition to the ones from the template

Navigation and search

• Go back to top button, great for long pages like API docs
• Site search widget
  • Search suggestions while typing
  • Search sharing
  • Searched terms highlighted on page
  • Search terms now able to be visible in analytics
• New version selector in the header (bye bye ugly RTD one)
• Single version site
• New language selector (only when translation exists)
• Sticky navigation tabs
• Section indexes (no need to create an "overview" page anymore, see the tutorial section for an example.)
• Per page TOC depth configuration (See tutorial.md page meta)

Configuration and build process

• Simpler configuration file for contributors
• Only requires Docker to build (no more Python version issues)
• No Git Submodule anymore, everything is included in the Docker image: build, tests and preview.
• New hosting (bye bye RTD, hello AWS S3)
• Sites hosted under consensys.net/docs/[project name]/[language]/[version]
• New code linter for Markdown but also all other files, config files (Github MegaLinter)
• Github-pages PR preview and PR preview comment

Content

• Last update of page on all sites
• Accessibility compliance tool (via AccessiBe)
• Common content sharing among sites
• Macros & filters in the MD pages
• Macros & filters at site level
• Macros & filters for all sites using the builder