3.5 KiB
layout, title, nav_order, description, permalink
| layout | title | nav_order | description | permalink |
|---|---|---|---|---|
| default | Home | 1 | Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages. | / |
Learn About Bitcoin
{: .fs-9 }
Bitcoin Archive gathers the most important primary and secondary source material on the creation of Bitcoin in a highly searchable research database. {: .fs-6 .fw-300 }
Get started now{: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } View it on GitHub{: .btn .fs-5 .mb-4 .mb-md-0 }
Getting started
Search
You can search any document in the archive by author, dates, and keywords. Try out terms like micropayment, VISA, Moore's Law, Mike Hearn, node, anonymous. Results will appear in real-time.
Sharing
Highlighting text will automatically update the permalink in browser so that you can link to any specific piece of text in any document. People who click the links you share will automatically jump to the highlighted text on the page.
Quick start: Use as a GitHub Pages remote theme
- Add Just the Docs to your Jekyll site's
_config.ymlas a remote theme
remote_theme: pmarsceill/just-the-docs
You must have GitHub Pages enabled on your repo, one or more Markdown files, and a _config.yml file. See an example repository
Local installation: Use the gem-based theme
- Install the Ruby Gem
$ gem install just-the-docs
# .. or add it to your your Jekyll site’s Gemfile
gem "just-the-docs"
- Add Just the Docs to your Jekyll site’s
_config.yml
theme: "just-the-docs"
- Optional: Initialize search data (creates
search-data.json)
$ bundle exec just-the-docs rake search:init
- Run you local Jekyll server
$ jekyll serve
# .. or if you're using a Gemfile (bundler)
$ bundle exec jekyll serve
- Point your web browser to http://localhost:4000
If you're hosting your site on GitHub Pages, set up GitHub Pages and Jekyll locally so that you can more easily work in your development environment.
Configure Just the Docs
- [See configuration options]({{ site.baseurl }}{% link docs/configuration.md %})
About the project
Bitcoin Archive is © 2020-{{ "now" | date: "%Y" }} by Deryk Makgill.
License
Bitcoin Archive is distributed by an MIT license.
Contributing
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in our GitHub repo.
Thank you to the contributors of Bitcoin Archive
Code of Conduct
Just the Docs is committed to fostering a welcoming community.
View our Code of Conduct on our GitHub repository.