This website is built using Docusaurus.
For simple changes to the documentation, click on the
Edit button at the top
of each page and submit those changes directly on GitHub.
One of the goals of Bitcoin-S is having useful and well-formatted Scaladoc comments on classes, objects and functions. Here are some useful resources on how to properly format your Scaladoc comments:
- Scaladoc for library authors
- Guidelines used by the official Scala language Scaladoc
- Alvin Alexander guide on writing Scaladoc
To generate Scaladocs:
$ sbt > unidoc > docs/mdoc
This gets placed in
website/static/api. When viewing the Docusaurus site the generated Scaladocs
appear under the API tab in the header bar,
or in the "API reference" link in the footer.
Running the site locally
For running the website locally, you'll need:
In case you want to contribute substantial structural changes to the website, we suggest to read Docusaurus' documentation first.
You can now build and launch the website using these commands:
cd website yarn install # only the first time, to install the dependencies yarn start
In a separate shell:
$ bloop run docs -- --watch
The above commands compiles our Mdoc Markdown files every time you change them, and puts them in the correct directory for Docusaurus to find them.
Now visit http://localhost:3000/ and you should see a local version of the website.
Adding a new page
Whenever you add a new markdown page to the documentation, you'll have to manually include it in the side menu.
You can do this by editing the
website/sidebars.json file. The name to use is
id specified in the page metadata (see the existing pages for an example).
Creating a new version
You can create a new version of the site by running this in the
yarn run version [MY-VERSION-HERE]
You also need to manually run
git add versioned_docs/version-[MY-VERSION-HERE]/ versioned_sidebars/version-[MY-VERSION-HERE]-sidebars.json
Publishing the site
$ sbt > docs/publishWebsite
This command first generates Scaladocs, then invokes
docs/docusaurusPublishGhPages, which in turn compile our mdoc
files, build the site and push them to GH pages.
Before running those commands, you might have to change a few constants in
siteConfig.js. These are specifed in the comments of that file.
Bitcoin-S uses Github Actions to run tests and deploy library and website builds. Generally
speaking CI has to pass for a PR to get merged. If you make documentation/website only
changes, you can start your PR title with
Docs:. This skips running tests on CI.