{"id":21528547,"url":"https://github.com/fibercrypto/docs","last_synced_at":"2025-03-17T18:45:31.011Z","repository":{"id":100092855,"uuid":"221083825","full_name":"fibercrypto/docs","owner":"fibercrypto","description":"Developer information","archived":false,"fork":false,"pushed_at":"2019-12-09T06:32:37.000Z","size":9910,"stargazers_count":0,"open_issues_count":33,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-24T06:11:22.550Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fibercrypto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-11T22:46:19.000Z","updated_at":"2019-12-09T06:32:40.000Z","dependencies_parsed_at":"2023-03-16T21:45:37.003Z","dependency_job_id":null,"html_url":"https://github.com/fibercrypto/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fibercrypto%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fibercrypto%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fibercrypto%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fibercrypto%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fibercrypto","download_url":"https://codeload.github.com/fibercrypto/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244092057,"owners_count":20396726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T01:53:36.546Z","updated_at":"2025-03-17T18:45:31.006Z","avatar_url":"https://github.com/fibercrypto.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"![docs](https://user-images.githubusercontent.com/8619106/56056146-02264800-5d79-11e9-8483-1c891c3c49f4.png)\n\n# Skycoin Docs Website Documentation\n\n[![Build Status](https://travis-ci.com/skycoin/docs.svg?branch=master)](https://travis-ci.com/skycoin/docs)\n\nThe documentation in this repo is uploaded to https://www.skycoin.net/docs/.\n\nThis documentation is not comprehensive, please see the Github wikis of other Skycoin code repositories for more information.\nFor example, the [Skycoin wiki](https://github.com/skycoin/skycoin/wiki) and the [Skywire wiki](https://github.com/skycoin/skywire/wiki).\nThere is also more information in the [Skycoin blog](https://www.skycoin.net/blog/).\n\n## Content\n\nThere are two types of documentation:\n\n1. User guides, tutorials, layman explanations (`user-guides` folder)\n2. Technical documentation (`docs` folder)\n\nAdditionally, there is a glossary.\n\nIn this repository [hugo](https://gohugo.io/) is used to generate a static website from markdown files.\n\nRefer to [hugo documentation](https://gohugo.io) to [get started](https://gohugo.io/getting-started/quick-start/).\n\n### Create or Amend Posts\n\nLook in the `content/` folder.  Articles are written in markdown.\n\nLocally, the web site can be previewed with:\n\n```sh\nmake run\n```\n\nThe 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`.\n\nTo get started make sure that your posts compile without error. Check the formatting.\n\nThen, commit the changes and push.\n\nIf there are no problems, then your pages at `http://localhost:1313/docs/` will automatically updated in a few minutes.\n\n### Glossary\n\nGlossary definitions are in the `data/glossary/` folder. Follow the existing format to add a new definition and it will\nappear on the glossary page.\n\n## Themes: Layout and Styling\n\nThe Skycoin Documentation website uses a custom hugo theme with styling produced using SCSS.\nWhen editing any styles you **must** edit the `.scss` files only.\nIf any changes are made to the SCSS partials within `static/css/scss/`,\nyou must re-compile with the following commands.\n\nMove into the theme directory:\n\n```sh\ncd themes/skycoin/\n```\n\nInstall the dependencies such as `node-sass`:\n\n```sh\nyarn\n# or\nnpm install\n```\n\nCompile and build the SCSS:\n\n```sh\nyarn build:css\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffibercrypto%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffibercrypto%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffibercrypto%2Fdocs/lists"}