{"id":18773630,"url":"https://github.com/protocol/docs-starter","last_synced_at":"2025-12-13T23:30:14.504Z","repository":{"id":91501745,"uuid":"554434517","full_name":"protocol/docs-starter","owner":"protocol","description":"Quickly create a really good documentation website by using this repo and a template.","archived":false,"fork":false,"pushed_at":"2023-03-22T15:02:38.000Z","size":11320,"stargazers_count":2,"open_issues_count":5,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-29T08:40:36.672Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","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/protocol.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":"2022-10-19T20:08:30.000Z","updated_at":"2024-02-27T23:57:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"8fe85830-8a0b-475c-a95d-68c9d3d768c6","html_url":"https://github.com/protocol/docs-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fdocs-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fdocs-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fdocs-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fdocs-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/protocol","download_url":"https://codeload.github.com/protocol/docs-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239680983,"owners_count":19679509,"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-07T19:34:39.029Z","updated_at":"2025-12-13T23:30:14.435Z","avatar_url":"https://github.com/protocol.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docs starter\n\nThis repository contains the base platform to build a docs site from. This platform is built using Hugo and started life in the [Doks repo by H-enk](https://github.com/h-enk/doks). This repo is designed to be used as a template and submodule. Follow through the [Create your project](#create-your-project) guide to set up everything properly.\n\n![A screenshot of one of the docs pages within this repo.](./static/images/site-screenshot.png)\n\n## Create your project\n\nYou can create your project quicking by following these steps.\n\n1. Clone this repo:\n\n    ```shell\n    git clone https://github.com/protocol/docs-starter\n    ```\n\n1. Move into the `docs-starter` directory and install the dependencies:\n\n    ```shell\n    cd docs-starter \u0026\u0026 npm install\n    ```\n\n1. Done!\n\n## Run locally\n\nOnce you have set up your project, you can start a local server by running the following steps.\n\n1. Run the local server with NPM:\n\n    ```shell\n    npm run start\n    ```\n\n1. Open [`localhost:1313` in your browser](http://localhost:1313).\n1. Stop the server with `CTRL` + `c`.\n\n## Maintaining content\n\nThis is how the website is organized in terms of menus and pages:\n\n1. Level 1 is the topbar navigation.\n1. Level 2 is the dropdown sections on the sidebar navigation.\n1. Level 3 is the pages below the dropdown sections in the sidebar navigation.\n1. Level 4 is the table of contents on the right of the page. This is automatically generated on each page and is not manually configurable.\nLorem ipsum.\n\n### Commands\n\nUse the following terminal commands to create new sections and pages.\n\n#### Topbar section\n\nTo create a new topbar section, run:\n\n```shell\nnpm run create -- --kind topbar \u003ctopbar item name\u003e\n```\n\nTo create a new level 1 section called _Basics_, run:\n\n```shell\nnpm run create -- --kind topbar basics\n```\n\n##### Add to the topbar menu\n\nTo add this new topbar section to the topbar menu, you must add the following in `./config/_default/menus/menus.en.toml`:\n\n```toml\n[[main]]\n  name = \"\u003ctopbar item name\u003e\"\n  url = \"/\u003ctopbar-item-name\u003e\"\n  weight = 1\n```\n\nTo add the _Basics_ section to the topbar nav that sends to users to `/basics/install/windows/` add:\n\n```toml\n[[main]]\n  name = \"Basics\"\n  url = \"/basics/install/windows/\"\n  weight = 1\n```\n\nThe lower the `weight` number, the further left the item will appear.\n\n#### Sidebar dropdown\n\nTo create a new sidebar dropdown, run:\n\n```shell\nnpm run create -- --kind sidebar \u003ctopbar section\u003e/\u003csidebar name\u003e\n```\n\nTo create a new level 2 section called _Install_ under the _Basics_ topbar section, run:\n\n```shell\nnpm run create -- --kind sidebar basics/install\n```\n\n#### Page\n\nTo create a new page, run:\n\n```shell\nnpm run create -- --kind page \u003ctopbar\u003e/\u003csidebar\u003e/\u003cpage title\u003e\n```\n\nTo create a new level 3 page called _Windows_ under the _Basics_ topbar section in the _Install_ dropdown, run:\n\n```shell\nnpm run create -- --kind page basics/install/windows\n```\n\n## Open-source projects used\n\n- [Doks](https://getdoks.org/) by [Henk Verlinde](https://henkverlinde.com/)\n- [CSS Tooltip](https://github.com/alterebro/css-tooltip) by [alterebro](https://github.com/alterebro)\n\n## Project todos\n\nThis is the stuff we're still working on.\n\n- [ ] Add in better pictures of dogs.\n- [ ] Automate favicon creation.\n- [ ] Automate adding item to topbar using `npm run create ...` commands.\n- [ ] Add setting to use image or text for topbar nav logo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotocol%2Fdocs-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotocol%2Fdocs-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotocol%2Fdocs-starter/lists"}