{"id":19298232,"url":"https://github.com/casbin/casbin-website-v2","last_synced_at":"2025-04-05T16:04:21.219Z","repository":{"id":37038719,"uuid":"488105076","full_name":"casbin/casbin-website-v2","owner":"casbin","description":"The new docs website for Casbin based on Docusaurus v2","archived":false,"fork":false,"pushed_at":"2025-03-16T04:06:58.000Z","size":10719,"stargazers_count":19,"open_issues_count":14,"forks_count":74,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-17T05:05:32.426Z","etag":null,"topics":["casbin","docs","documentation","docusaurus","v2"],"latest_commit_sha":null,"homepage":"https://casbin.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/casbin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/Contributing.mdx","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/SupportedModels.mdx","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"casbin"}},"created_at":"2022-05-03T06:47:41.000Z","updated_at":"2025-03-16T04:07:02.000Z","dependencies_parsed_at":"2023-12-28T14:01:06.731Z","dependency_job_id":"ad14e2c6-1e96-45b9-afce-875d34ee0d75","html_url":"https://github.com/casbin/casbin-website-v2","commit_stats":{"total_commits":821,"total_committers":141,"mean_commits":5.822695035460993,"dds":"0.48599269183922045","last_synced_commit":"ec9e98ed727e2f69562bb48e9028581e82dbc5e0"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casbin%2Fcasbin-website-v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casbin%2Fcasbin-website-v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casbin%2Fcasbin-website-v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/casbin%2Fcasbin-website-v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/casbin","download_url":"https://codeload.github.com/casbin/casbin-website-v2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244561202,"owners_count":20472368,"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":["casbin","docs","documentation","docusaurus","v2"],"created_at":"2024-11-09T23:07:19.678Z","updated_at":"2025-03-22T14:07:46.420Z","avatar_url":"https://github.com/casbin.png","language":"JavaScript","funding_links":["https://github.com/sponsors/casbin"],"categories":[],"sub_categories":[],"readme":"# [casbin.org](https://casbin.org) [![Build and Deploy](https://github.com/casbin/casbin-website-v2/actions/workflows/master.yml/badge.svg)](https://github.com/casbin/casbin-website-v2/actions/workflows/master.yml)\n\nThe configuration and documentation of Casbin website: \u003chttps://casbin.org/\u003e.\n\nCasbin website is built using [Docusaurus](https://docusaurus.io/), you can get the PDF at [casbin.org/pdf](https://casbin.org/pdf) or [GitHub Action](https://github.com/casbin/casbin-website-v2/actions/workflows/master.yml).\n\n## Get Started\n\n### Requirements\n\n1. [Git](https://git-scm.com/downloads)\n2. [Node.js](https://nodejs.org/en/download/)：v16.14 or above\n3. [Yarn](https://classic.yarnpkg.com/en/docs/install): please use Yarn 1\n\n### Running Locally\n\n1. `git clone https://github.com/casbin/casbin-website-v2.git`\n2. `cd casbin-website-v2`\n3. `yarn`: install dependencies.\n4. `yarn start`: starting the development server.\n\n## Contributing\n\nYou can contribute to the documentation site in different ways: [Documentation Writing](#documentation-writing), [Translation](#translation), [Website Development](#website-development).\n\n### Documentation Writing\n\nFor the configuration of the sidebar, you can refer to [Sidebar](https://docusaurus.io/docs/sidebar).\n\nFor the features that you may use when writing documents, please refer to [Markdown Features](https://docusaurus.io/docs/markdown-features).\n\nA standard document should look like this:\n\n````md\n---\ntitle: Title\ndescription: description\nkeywords: [keyword1, keyword2]\nauthors: [GitHub username]\n---\n\n## Headers\n\nOnly h2 and h3 will be in the TOC by default, so h1 is not recommended to use.\n\n### h3\n\ncontent\n\n#### h4\n\ncontent\n\n````\n\nWe use [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to lint the markdown and mdx files, you can use the following command to fix basic errors and get a list of document issues:\n\n```bash\nyarn lint:md\n```\n\nIf you write docs using VSCode, Sublime, or Vim/Neovim, you can install the [extension](https://github.com/DavidAnson/markdownlint#related) to get better lint experience.\n\n#### Caution\n\n##### Admonitions\n\nYou can add [Admonitions](https://docusaurus.io/docs/markdown-features/admonitions) in the documentation, but please leave two blank lines like this:\n\n```md\n:::info Title\n\nTitle is optional\n\n:::\n```\n\n##### JSX\n\nYou can use JSX in documents, such as the [Tabs](https://docusaurus.io/docs/markdown-features/tabs) component provided by Docusaurus, but to prevent Crowdin from breaking the code ([mdx-solutions](https://docusaurus.io/docs/i18n/crowdin#mdx-solutions)), please wrap the JSX code:\n\n````md\n```mdx-code-block\nimport Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';\n```\n\n```mdx-code-block\n\u003cTabs\u003e\n\u003cTabItem value=\"go\" label=\"Go\"\u003e\n```\n\ncontent\n\n```mdx-code-block\n\u003c/TabItem\u003e\n\u003cTabItem value=\"java\" label=\"Java\"\u003e\n```\n\ncontent\n\n```mdx-code-block\n\u003c/TabItem\u003e\n\u003c/Tabs\u003e\n```\n\n````\n\n### Translation\n\n[Crowdin](https://crowdin.com/project/casbin-website) and [Docusaurus i18n](https://docusaurus.io/docs/i18n/introduction) is used for Casbin website's translation.\n\nNote: Please do not translate strings like `:::note`, `:::tip`, wrong translation may cause typographical error([casdoor-website#305](https://github.com/casdoor/casdoor-website/issues/305)).\n\nYou may see some sentences containing `{}`, like:\n\n```text\nAt our {repoLink}, browse and submit {issueLink} or {prLink} for bugs you find or any new features you may want implemented.\n```\n\nPlease do not translate `{repoLink}` or `{issueLink}` or any similar words, they are [interpolation placeholders](https://docusaurus.io/docs/docusaurus-core#translate-props).\n\nPlease don't translate sentences like `authors: [casdoor]`.\n\n### Website Development\n\nSee [Creating Pages](https://docusaurus.io/docs/creating-pages) to learn how to create a page.\n\nSee [Styling and Layout](https://docusaurus.io/docs/styling-layout) to learn how to modify styles.\n\nSee [Swizzling](https://docusaurus.io/docs/swizzling) to learn how to modify Docusaurus built-in components.\n\n## LICENSE\n\n[Apache-2.0 license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcasbin%2Fcasbin-website-v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcasbin%2Fcasbin-website-v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcasbin%2Fcasbin-website-v2/lists"}