mirror of
https://github.com/bitcoin-s/bitcoin-s.git
synced 2025-03-19 13:35:17 +01:00
115 lines
15 KiB
HTML
115 lines
15 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Contributing to the website · bitcoin-s</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p>This website is built using <a href="https://docusaurus.io/">Docusaurus</a>.</p>
|
|||
|
|
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Contributing to the website · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="<p>This website is built using <a href="https://docusaurus.io/">Docusaurus</a>.</p>
|
|||
|
|
"/><meta property="og:image" content="https://bitcoin-s.org/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://bitcoin-s.org/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://bitcoin-s.org/blog/atom.xml" title="bitcoin-s Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://bitcoin-s.org/blog/feed.xml" title="bitcoin-s Blog RSS Feed"/><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="https://fonts.googleapis.com/css?family=Montserrat:500"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/favicon.ico" alt="bitcoin-s"/><h2 class="headerTitleWithLogo">bitcoin-s</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/core/core-intro" target="_self">Docs</a></li><li class=""><a href="/api/org/bitcoins" target="_self">API</a></li><li class=""><a href="/help" target="_self">Help</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Contributing</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/getting-started">Add Bitcoin-S to your project</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Core module</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/core/core-intro">Core module</a></li><li class="navListItem"><a class="navItem" href="/docs/core/txbuilder">TxBuilder example</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">RPC clients</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/rpc/rpc-clients-intro">Introduction</a></li><li class="navListItem"><a class="navItem" href="/docs/rpc/rpc-eclair">Eclair</a></li><li class="navListItem"><a class="navItem" href="/docs/rpc/rpc-bitcoind">bitcoind/Bitcoin Core</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Contributing</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/contributing">Contributing</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/contributing-website">Contributing to the website</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Security</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/security">Security</a></li></ul></div></div></section></div><script>
|
|||
|
|
var coll = document.getElementsByClassName('collapsible');
|
|||
|
|
var checkActiveCategory = true;
|
|||
|
|
for (var i = 0; i < coll.length; i++) {
|
|||
|
|
var links = coll[i].nextElementSibling.getElementsByTagName('*');
|
|||
|
|
if (checkActiveCategory){
|
|||
|
|
for (var j = 0; j < links.length; j++) {
|
|||
|
|
if (links[j].classList.contains('navListItemActive')){
|
|||
|
|
coll[i].nextElementSibling.classList.toggle('hide');
|
|||
|
|
coll[i].childNodes[1].classList.toggle('rotate');
|
|||
|
|
checkActiveCategory = false;
|
|||
|
|
break;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
coll[i].addEventListener('click', function() {
|
|||
|
|
var arrow = this.childNodes[1];
|
|||
|
|
arrow.classList.toggle('rotate');
|
|||
|
|
var content = this.nextElementSibling;
|
|||
|
|
content.classList.toggle('hide');
|
|||
|
|
});
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
document.addEventListener('DOMContentLoaded', function() {
|
|||
|
|
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
|||
|
|
createToggler('#tocToggler', 'body', 'tocActive');
|
|||
|
|
|
|||
|
|
const headings = document.querySelector('.toc-headings');
|
|||
|
|
headings && headings.addEventListener('click', function(event) {
|
|||
|
|
if (event.target.tagName === 'A') {
|
|||
|
|
document.body.classList.remove('tocActive');
|
|||
|
|
}
|
|||
|
|
}, false);
|
|||
|
|
|
|||
|
|
function createToggler(togglerSelector, targetSelector, className) {
|
|||
|
|
var toggler = document.querySelector(togglerSelector);
|
|||
|
|
var target = document.querySelector(targetSelector);
|
|||
|
|
|
|||
|
|
if (!toggler) {
|
|||
|
|
return;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
toggler.onclick = function(event) {
|
|||
|
|
event.preventDefault();
|
|||
|
|
|
|||
|
|
target.classList.toggle(className);
|
|||
|
|
};
|
|||
|
|
}
|
|||
|
|
});
|
|||
|
|
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/docscontributing-website.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Contributing to the website</h1></header><article><div><span><p>This website is built using <a href="https://docusaurus.io/">Docusaurus</a>.</p>
|
|||
|
|
<p>For simple changes to the documentation, click on the <code>Edit</code> button at the top
|
|||
|
|
of each page and submit those changes directly on GitHub.</p>
|
|||
|
|
<h2><a class="anchor" aria-hidden="true" id="scaladoc"></a><a href="#scaladoc" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Scaladoc</h2>
|
|||
|
|
<p>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:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html">Scaladoc for library authors</a></li>
|
|||
|
|
<li><a href="https://docs.scala-lang.org/style/scaladoc.html">Guidelines</a> used by the official Scala language Scaladoc</li>
|
|||
|
|
<li><a href="https://alvinalexander.com/scala/how-to-generate-scala-documentation-scaladoc-command-examples">Alvin Alexander guide</a> on writing Scaladoc</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>To generate Scaladocs:</p>
|
|||
|
|
<pre><code class="hljs css language-bash">$ sbt
|
|||
|
|
> unidoc
|
|||
|
|
</code></pre>
|
|||
|
|
<p>This gets placed in <code>website/static/api</code>. 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.</p>
|
|||
|
|
<h2><a class="anchor" aria-hidden="true" id="running-the-site-locally"></a><a href="#running-the-site-locally" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Running the site locally</h2>
|
|||
|
|
<p>For running the website locally, you'll need:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>yarn</code> (<a href="https://yarnpkg.com/lang/en/docs/install-ci/">https://yarnpkg.com/lang/en/docs/install-ci/</a>)</li>
|
|||
|
|
<li><code>sbt</code> (<a href="https://www.scala-sbt.org/1.0/docs/Setup.html">https://www.scala-sbt.org/1.0/docs/Setup.html</a>)</li>
|
|||
|
|
</ul>
|
|||
|
|
<blockquote>
|
|||
|
|
<p>In case you want to contribute substantial structural changes to the website,
|
|||
|
|
we suggest to read
|
|||
|
|
<a href="https://docusaurus.io/docs/en/installation.html">Docusaurus' documentation</a>
|
|||
|
|
first.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>You can now build and launch the website using
|
|||
|
|
these commands:</p>
|
|||
|
|
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> website
|
|||
|
|
yarn install <span class="hljs-comment"># only the first time, to install the dependencies</span>
|
|||
|
|
yarn start
|
|||
|
|
</code></pre>
|
|||
|
|
<p>In a separate shell:</p>
|
|||
|
|
<pre><code class="hljs css language-bash">$ sbt
|
|||
|
|
> docs/mdoc --watch
|
|||
|
|
</code></pre>
|
|||
|
|
<p>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.</p>
|
|||
|
|
<p>Now visit <a href="http://localhost:3000/">http://localhost:3000/</a> and you should see a local version of
|
|||
|
|
the website.</p>
|
|||
|
|
<h2><a class="anchor" aria-hidden="true" id="adding-a-new-page"></a><a href="#adding-a-new-page" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Adding a new page</h2>
|
|||
|
|
<p>Whenever you add a new markdown page to the documentation, you'll have to
|
|||
|
|
manually include it in the side menu.</p>
|
|||
|
|
<p>You can do this by editing the <code>website/sidebars.json</code> file. The name to use is
|
|||
|
|
the <code>id</code> specified in the page metadata (see the existing pages for an example).</p>
|
|||
|
|
<h2><a class="anchor" aria-hidden="true" id="publishing-the-site"></a><a href="#publishing-the-site" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Publishing the site</h2>
|
|||
|
|
<pre><code class="hljs css language-bash">$ sbt
|
|||
|
|
> docs/publishWebsite
|
|||
|
|
</code></pre>
|
|||
|
|
<p>This command first generates Scaladocs, then invokes
|
|||
|
|
<code>docs/docusaurusPublishGhPages</code>, which in turn compile our mdoc
|
|||
|
|
files, build the site and push them to GH pages.</p>
|
|||
|
|
<p>Before running those commands, you might have to change a few constants in
|
|||
|
|
<code>siteConfig.js</code>. These are specifed in the comments of that file.</p>
|
|||
|
|
<h3><a class="anchor" aria-hidden="true" id="ci"></a><a href="#ci" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>CI</h3>
|
|||
|
|
<p>Bitcoin-S uses Travis 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 <code>Docs:</code>. This skips running tests on CI.</p>
|
|||
|
|
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/contributing"><span class="arrow-prev">← </span><span>Contributing</span></a><a class="docs-next button" href="/docs/security"><span>Security</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#scaladoc">Scaladoc</a></li><li><a href="#running-the-site-locally">Running the site locally</a></li><li><a href="#adding-a-new-page">Adding a new page</a></li><li><a href="#publishing-the-site">Publishing the site</a><ul class="toc-headings"><li><a href="#ci">CI</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 Suredbits & the bitcoin-s developers</section></footer></div></body></html>
|