https://github.com/fibercrypto/docs
Developer information
https://github.com/fibercrypto/docs
Last synced: over 1 year ago
JSON representation
Developer information
- Host: GitHub
- URL: https://github.com/fibercrypto/docs
- Owner: fibercrypto
- Created: 2019-11-11T22:46:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-09T06:32:37.000Z (over 6 years ago)
- Last Synced: 2025-01-24T06:11:22.550Z (over 1 year ago)
- Language: CSS
- Size: 9.45 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Skycoin Docs Website Documentation
[](https://travis-ci.com/skycoin/docs)
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](https://github.com/skycoin/skycoin/wiki) and the [Skywire wiki](https://github.com/skycoin/skywire/wiki).
There is also more information in the [Skycoin blog](https://www.skycoin.net/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](https://gohugo.io/) is used to generate a static website from markdown files.
Refer to [hugo documentation](https://gohugo.io) to [get started](https://gohugo.io/getting-started/quick-start/).
### Create or Amend Posts
Look in the `content/` folder. Articles are written in markdown.
Locally, the web site can be previewed with:
```sh
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:
```sh
cd themes/skycoin/
```
Install the dependencies such as `node-sass`:
```sh
yarn
# or
npm install
```
Compile and build the SCSS:
```sh
yarn build:css
```