Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.29 KB

README.md

File metadata and controls

74 lines (46 loc) · 2.29 KB
Raw

docs

Skycoin Docs Website Documentation

Build Status

The documentation in this repo is uploaded to https://www.skycoin.net/docs/.

This documentation is not comprehensive, please see the Github wikis of other Skycoin code repositories for more information. For example, the Skycoin wiki and the Skywire wiki. There is also more information in the Skycoin blog.

Content

There are two types of documentation:

  1. User guides, tutorials, layman explanations (user-guides folder)
  2. Technical documentation (docs folder)

Additionally, there is a glossary.

In this repository hugo is used to generate a static website from markdown files.

Refer to hugo documentation to get started.

Create or Amend Posts

Look in the content/ folder. Articles are written in markdown.

Locally, the web site can be previewed with:

make run

The web site will be available at http://localhost:1313/docs/ immediately after. Notice that the port may be different if another service is bound to 1313.

To get started make sure that your posts compile without error. Check the formatting.

Then, commit the changes and push.

If there are no problems, then your pages at http://localhost:1313/docs/ will automatically updated in a few minutes.

Glossary

Glossary definitions are in the data/glossary/ folder. Follow the existing format to add a new definition and it will appear on the glossary page.

Themes: Layout and Styling

The Skycoin Documentation website uses a custom hugo theme with styling produced using SCSS. When editing any styles you must edit the .scss files only. If any changes are made to the SCSS partials within static/css/scss/, you must re-compile with the following commands.

Move into the theme directory:

cd themes/skycoin/

Install the dependencies such as node-sass:

yarn
# or
npm install

Compile and build the SCSS:

yarn build:css