{"id":20895433,"url":"https://github.com/nutsdb/nutsdb-docs","last_synced_at":"2026-04-20T08:33:18.551Z","repository":{"id":43079317,"uuid":"471735178","full_name":"nutsdb/nutsdb-docs","owner":"nutsdb","description":"NutsDB Document (WIP)","archived":false,"fork":false,"pushed_at":"2024-01-08T02:58:44.000Z","size":1726,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-26T20:11:36.042Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nutsdb.github.io/nutsdb-docs/","language":"TypeScript","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/nutsdb.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-03-19T15:27:11.000Z","updated_at":"2023-12-27T14:48:34.000Z","dependencies_parsed_at":"2024-01-08T03:43:18.267Z","dependency_job_id":"aa945bea-d899-4400-a326-0ded5c3ee62d","html_url":"https://github.com/nutsdb/nutsdb-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nutsdb/nutsdb-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutsdb%2Fnutsdb-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutsdb%2Fnutsdb-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutsdb%2Fnutsdb-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutsdb%2Fnutsdb-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nutsdb","download_url":"https://codeload.github.com/nutsdb/nutsdb-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nutsdb%2Fnutsdb-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32040185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-18T10:28:51.411Z","updated_at":"2026-04-20T08:33:18.485Z","avatar_url":"https://github.com/nutsdb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NutsDB Documents\n\n\u003e This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. This `README` file may not be detailed enough, so we can find more details on the doc site of Docusaurus. Certainly, welcome to submit a new issue.\n\n## How to run locally\n\nThis repo is using `node` and `docusaurus`. So we must install a node (`\u003e= 18`) firstly.\n\n1. Use `yarn install` to install all dependencies of this repo.\n2. Use `yarn start` to start docs site locally\n\n## How to create a page of documents\n\n1. Create a `.md` file in `./docs` or in the child directories of `./docs`, name it with a related filename.\n2. Open `./sidebar.ts`. This is a file used to define the sidebar structure. Now we use a manual sidebar configure. Find a correct position in `sidebars-\u003etutorialSidebar` of `./sidebar.ts` and add the corresponding records.\n3. Writing something in created file.\n\n## How to create a blog\n\n1. Just like creating a page of documents. Create a `.md` file in `./blogs`.\n2. No need to update `./sidebar.ts` and we can write something in the created file.\n\n## How to create a document/blog in multi-language\n\nNow we support Chinese and English. If we want to create a Chinese page, we can directly add it in `./docs` or `./blogs`.\n\nIf we want to add an English translation, we need add a new file to `./i18n/en/docusaurus-plugin-content-docs/current` or `./i18n/en/docusaurus-plugin-content-blogs/current`. We can keep the same directory structure with the `./docs` and `./blogs` in these English file directories.\n\n## Something more\n\n### Use `go` as the language block name\n\nIf we want to display highlighted code, we need use `go` but `golang` as the language block name. Because `Docusaurus` seems only support `go`.\n\nJust like:\n\n\u003e \\`\\`\\`go\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnutsdb%2Fnutsdb-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnutsdb%2Fnutsdb-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnutsdb%2Fnutsdb-docs/lists"}