{"id":18674077,"url":"https://github.com/nervosnetwork/docs.nervos.org","last_synced_at":"2025-04-06T09:10:47.156Z","repository":{"id":37981863,"uuid":"254575057","full_name":"nervosnetwork/docs.nervos.org","owner":"nervosnetwork","description":"Nervos CKB Documentation, curated by Nervos Foundation, contributed by the Nervos Community with ❤️.","archived":false,"fork":false,"pushed_at":"2024-10-29T08:10:22.000Z","size":98427,"stargazers_count":18,"open_issues_count":10,"forks_count":62,"subscribers_count":16,"default_branch":"develop","last_synced_at":"2024-10-29T09:26:45.274Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.nervos.org/","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nervosnetwork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2020-04-10T07:45:45.000Z","updated_at":"2024-10-25T08:26:29.000Z","dependencies_parsed_at":"2023-11-29T04:22:17.521Z","dependency_job_id":"bc508e26-df40-4686-b279-9580a5406f47","html_url":"https://github.com/nervosnetwork/docs.nervos.org","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fdocs.nervos.org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fdocs.nervos.org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fdocs.nervos.org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nervosnetwork%2Fdocs.nervos.org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nervosnetwork","download_url":"https://codeload.github.com/nervosnetwork/docs.nervos.org/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457803,"owners_count":20941906,"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-07T09:17:25.423Z","updated_at":"2025-04-06T09:10:47.140Z","avatar_url":"https://github.com/nervosnetwork.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nervos CKB Documentation Website\n\n- [Nervos CKB Documentation Website](#nervos-ckb-documentation-website)\n\t- [What is CKB](#what-is-ckb)\n\t- [Contributing](#contributing)\n\t\t- [Branches](#branches)\n\t\t- [Code structure](#code-structure)\n\t\t- [Develop](#develop)\n\t\t\t- [Clone the Repo](#clone-the-repo)\n\t\t\t- [Install Dependencies](#install-dependencies)\n\t\t\t- [Run the website](#run-the-website)\n\t\t\t- [Build for deployment](#build-for-deployment)\n\n## What is CKB\n\nNervos CKB is a public permissionless blockchain and the layer 1 of Nervos.\n\nCKB generates trust and extends this trust to upper layers, making Nervos a trust network. It's also the value store of the Nervos network, providing public, secure and censorship-resistant custody services for assets, identities and other common knowledge created in the network. We will also vigorously develop the developer community and aim to offer blockchain developers exciting new capabilities.\n\nIf you run into an issue on our documentation website you can contact us on [Nervos talk](https://talk.nervos.org/) or [Discord](https://discord.gg/AqGTUE9).\n\n## Contributing\n\n### Branches\n\n- production branch: [develop](https://github.com/nervosnetwork/docs.nervos.org/tree/develop)\n- current developing branch: [v2](https://github.com/nervosnetwork/docs.nervos.org/tree/v2)\n- old version developing branch: [v1](https://github.com/nervosnetwork/docs.nervos.org/tree/v1)\n\n### Code structure\n\n```bash\n├── LICENSE\n├── README.md\n├── examples\n└── website\n    ├── build\n    ├── docs\n    ├── docusaurus.config.js\n    ├── node_modules\n    ├── package.json\n    ├── sidebars.js\n    ├── src\n    ├── static\n    ├── tsconfig.json\n    └── yarn.lock\n```\n\n- `website`: The doc site is built with [docusaurus](https://docusaurus.io/) and under the `website` folder.\n- `examples`: The `examples` folder contains full tutorial codes you can clone.\n\n### Develop\n\n#### Clone the Repo\n\n```bash\ngit clone https://github.com/nervosnetwork/docs.nervos.org.git\ncd docs.nervos.org\ncd website\n```\n\n#### Install Dependencies\n\nInstall [yarn](https://yarnpkg.com/en/).\n\nIn `website` folder:\n\n```bash\nyarn install\n```\n\n#### Run the website\n\nIn `website` folder:\n\n```bash\nyarn start\n```\n\n```bash\n[INFO] Starting the development server...\n[SUCCESS] Docusaurus website is running at: http://localhost:3000/\n```\n\nYou can check out the website at http://localhost:3000/ in your browser now.\n\n#### Build for deployment\n\nIn `website` folder:\n\n```bash\nyarn build\n```\n\n#### Maintain key-terms.json file\nThe `key-terms.json` file is generated from the glossary in the `docs/tech-explanation/glossary.md` file. This file is used by the Tooltip component to provide definitions and links to key terms throughout the documentation.\n\nOnce you have updates in `glossary.md`, please remember to run the following command in the `website` folder to re-generate the `key-terms.json` file:\n\n```bash\nyarn gen-terms\n```\n\nAfter running the command, you can navigate to `src/components/Tooltip` to verify that the `key-terms.json` file has been generated successfully.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnervosnetwork%2Fdocs.nervos.org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnervosnetwork%2Fdocs.nervos.org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnervosnetwork%2Fdocs.nervos.org/lists"}