{"id":18932659,"url":"https://github.com/yougotwill/docs-starter","last_synced_at":"2026-05-09T10:24:45.154Z","repository":{"id":106185200,"uuid":"460707709","full_name":"yougotwill/docs-starter","owner":"yougotwill","description":"Documentation Website Template","archived":false,"fork":false,"pushed_at":"2022-02-18T04:21:26.000Z","size":232,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-31T20:28:31.606Z","etag":null,"topics":["documentation","docusaurus","markdown","react","static-site-generator","template","website"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/yougotwill.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-02-18T04:21:22.000Z","updated_at":"2022-02-18T04:22:25.000Z","dependencies_parsed_at":"2023-06-16T01:15:42.980Z","dependency_job_id":null,"html_url":"https://github.com/yougotwill/docs-starter","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/yougotwill%2Fdocs-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yougotwill%2Fdocs-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yougotwill%2Fdocs-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yougotwill%2Fdocs-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yougotwill","download_url":"https://codeload.github.com/yougotwill/docs-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239931521,"owners_count":19720535,"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":["documentation","docusaurus","markdown","react","static-site-generator","template","website"],"created_at":"2024-11-08T11:50:07.607Z","updated_at":"2026-03-18T12:30:15.756Z","avatar_url":"https://github.com/yougotwill.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Website Template\n\nThis documentation website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.\n\n## Installation\n\n```\n$ yarn\n```\n\n## Local Development\n\n```\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```\n$ yarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n### Serve\n\n```\n$ yarn serve\n```\n\nThis command serves the static content of the `build` directory locally and opens up a browser window.\n\n## Deployment\n\nUsing SSH:\n\n```\n$ USE_SSH=true yarn deploy\n```\n\nNot using SSH:\n\n```\n$ GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n```\n\nIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.\n\n## Getting Started\n\n### Project Structure\n\n- `/docs/` - Contains the Markdown files for the docs. Customize the order of the docs sidebar in `sidebars.js`. More details can be found in the [docs guide](https://docusaurus.io/docs/docs-markdown-features)\n- `/src/` - Non-documentation files like pages or custom React components. You don't have to strictly put your non-documentation files in here but putting them under a centralized directory makes it easier to specify in case you need to do some sort of linting`/processing\n  - `/src/pages` - Any files within this directory will be converted into a website page. More details can be found in the [pages guide](https://docusaurus.io/docs/creating-pages)\n- `/static/` - Static directory. Any contents inside here will be copied into the root of the final build directory\n- `/docusaurus.config.js` - A config file containing the site configuration.\n- `/sidebar.js` - Used by the documentation to specify the order of documents in the sidebar\n\n### Metadata and Styles\n\n1. Add your site metadata to [docusaurus.config.js](/docusaurus.config.js).\n2. Pick a color and then generate the required shades using this [tool](https://docusaurus.io/docs/styling-layout#primary_color).\n3. Overwrite the color variables in [custom.css](/src/css/custom.css).\n4. Adjust the searchbar to match your color palette by overwriting `--aa-selected-color-rgb` with the `rgb` format of `--ifm-color-primary` in [custom.css](/src/css/custom.css) for both the light and dark themes.\n\n### Writing docs\n\n1. Routing works by generating url slugs using the relative path of a file / folder within the [docs](/docs) folder.\n2. To order folders or files you can put `XX-` infront of the name. e.g. `01-tutorial-basics/` or `01-create-a-page.md`.\n\n   The page title can then be changed using the following methods.\n\n   1. For markdown files you can use either a `#Heading` or specify the title using the `label` field in the `YAML` frontmatter of the file.\n\n      ```yaml\n      ---\n      label: Tutorial Basics\n      ---\n      ```\n\n   2. For folders you can create a `JSON` file within the folder called `_category_.json`.\n\n      ```json\n      {\n        \"label\": \"Tutorial Basics\"\n      }\n      ```\n\n#### Markdown Frontmatter\n\n\u003c!-- prettier-ignore-start --\u003e\n| Name                     | Type            | Default                                              | Description                                                  |\n| ------------------------ | --------------- | ---------------------------------------------------- | ------------------------------------------------------------ |\n| `id`                     | `string`        | file path (including folders, without the extension) | A unique document id.                                        |\n| `title`                  | `string`        | Markdown title or `id`                               | The text title of your document. Used for the page metadata and as a  fallback value in multiple places (sidebar, next/previous buttons...).  Automatically added at the top of your doc if it does not contain any  Markdown title. |\n| `pagination_label`       | `string`        | `sidebar_label` or `title`                           | The text used in the document next/previous buttons for this document. |\n| `sidebar_label`          | `string`        | `title`                                              | The text shown in the document sidebar for this document.    |\n| `sidebar_position`       | `number`        | Default ordering                                     | Controls the position of a doc inside the generated sidebar slice when using `autogenerated` sidebar items. See also [Autogenerated sidebar metadatas](https://docusaurus.io/docs/sidebar#autogenerated-sidebar-metadatas). |\n| `sidebar_class_name`     | `string`        | `undefined`                                          | Gives the corresponding sidebar label a special class name when using autogenerated sidebars. |\n| `hide_title`             | `boolean`       | `false`                                              | Whether to hide the title at the top of the doc. It only hides a title declared through the frontmatter, and have no effect on a Markdown title at the  top of your document. |\n| `hide_table_of_contents` | `boolean`       | `false`                                              | Whether to hide the table of contents to the right.          |\n| `toc_min_heading_level`  | `number`        | `2`                                                  | The minimum heading level shown in the table of contents. Must be between 2 and 6 and lower or equal to the max value. |\n| `toc_max_heading_level`  | `number`        | `3`                                                  | The max heading level shown in the table of contents. Must be between 2 and 6. |\n| `pagination_next`        | `string | null` | Next doc in the sidebar                              | The ID of the documentation you want the \"Next\" pagination to link to. Use `null` to disable showing \"Next\" for this page. |\n| `pagination_prev`        | `string | null` | Previous doc in the sidebar                          | The ID of the documentation you want the \"Previous\" pagination to link to. Use `null` to disable showing \"Previous\" for this page. |\n| `parse_number_prefixes`  | `boolean`       | `numberPrefixParser` plugin option                   | Whether number prefix parsing is disabled on this doc. See also [Using number prefixes](https://docusaurus.io/docs/sidebar#using-number-prefixes). |\n| `custom_edit_url`        | `string`        | Computed using the `editUrl` plugin option           | The URL for editing this document.                           |\n| `keywords`               | `string[]`      | `undefined`                                          | Keywords meta tag for the document page, for search engines. |\n| `description`            | `string`        | The first line of Markdown content                   | The description of your document, which will become the `\u003cmeta name=\"description\" content=\"...\"/\u003e` and `\u003cmeta property=\"og:description\" content=\"...\"/\u003e` in `\u003chead\u003e`, used by search engines. |\n| `image`                  | `string`        | `undefined`                                          | Cover or thumbnail image that will be used when displaying the link to your post. |\n| `slug`                   | `string`        | File path                                            | Allows to customize the document url (`/\u003crouteBasePath\u003e/\u003cslug\u003e`). Support multiple patterns: `slug: my-doc`, `slug: /my/path/myDoc`, `slug: /`. |\n| `tags`                   | `Tag[]`         | `undefined`                                          | A list of strings or objects of two string fields `label` and `permalink` to tag to your docs. |\n\n\u003c!-- prettier-ignore-end --\u003e\n\n## References\n\n[Docusaurus.io](https://docusaurus.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyougotwill%2Fdocs-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyougotwill%2Fdocs-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyougotwill%2Fdocs-starter/lists"}