Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Hyperledger documentation on ReadtheDocs is populated by files from the various Hyperledger project GitHub pages
  • Those GitHub pages are synced with the ReadtheDocs platform and Pull Requests sync up an index.rst file
  • The index.rst file, as the extension might imply, is built upon Sphinx and reStructured syntax. (RST stands for reStructured) 
  • Sphinx and reStructured have their own syntax, formatting and are designed specifically for formatting documentation 
  • reStructured is not a full fledged markdown language, but does allow for some customization 
    • images and images with hyperlinks are available 
    • various themes are available
    • backgrounds for code snippets like dark mode are available 
    • plug-ins for custom CSS and JS are available

Image Added