Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/casbin/caswaf-website
The docs website for CasWAF: https://github.com/casbin/caswaf
https://github.com/casbin/caswaf-website
casbin caswaf docs documentation docusaurus
Last synced: about 1 month ago
JSON representation
The docs website for CasWAF: https://github.com/casbin/caswaf
- Host: GitHub
- URL: https://github.com/casbin/caswaf-website
- Owner: casbin
- License: apache-2.0
- Created: 2023-07-15T17:01:34.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-08T14:34:12.000Z (3 months ago)
- Last Synced: 2024-10-29T22:37:45.087Z (about 2 months ago)
- Topics: casbin, caswaf, docs, documentation, docusaurus
- Language: JavaScript
- Homepage: https://caswaf.org
- Size: 2.81 MB
- Stars: 2
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [caswaf.org](https://caswaf.org) [](https://github.com/casbin/caswaf-website/actions/workflows/master.yml)
The configuration and documentation of caswaf website: .
caswaf website is built using [Docusaurus](https://docusaurus.io/), you can get the PDF at [caswaf.org/pdf](https://caswaf.org/pdf) or [GitHub Action](https://github.com/casbin/caswaf-website/actions/workflows/master.yml).
## Get Started
### Requirements
1. [Git](https://git-scm.com/downloads)
2. [Node.js](https://nodejs.org/en/download/)：v16.14 or above
3. [Yarn](https://classic.yarnpkg.com/en/docs/install): please use Yarn 1
### Running Locally
1. `git clone https://github.com/casbin/caswaf-website.git`
2. `cd caswaf-website`
3. `yarn`: install dependencies.
4. `yarn start`: starting the development server.
## Contributing
You can contribute to the documentation site in different ways: [Documentation Writing](#documentation-writing), [Translation](#translation), [Website Development](#website-development).
### Documentation Writing
For the configuration of the sidebar, you can refer to [Sidebar](https://docusaurus.io/docs/sidebar).
For the features that you may use when writing documents, please refer to [Markdown Features](https://docusaurus.io/docs/markdown-features).
A standard document should look like this:
````md
---
title: Title
description: description
keywords: [keyword1, keyword2]
authors: [GitHub username]
---
## Headers
Only h2 and h3 will be in the TOC by default, so h1 is not recommended to use.
### h3
content
#### h4
content
````
We 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:
```bash
yarn lint:md
```
If 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.
#### Caution
##### Admonitions
You can add [Admonitions](https://docusaurus.io/docs/markdown-features/admonitions) in the documentation, but please leave two blank lines like this:
```md
:::info Title
Title is optional
:::
```
##### JSX
You 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:
````md
```mdx-code-block
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
```
```mdx-code-block
```
content
```mdx-code-block
```
content
```mdx-code-block
```
````
### Translation
[Crowdin](https://crowdin.com/project/caswaf-website) and [Docusaurus i18n](https://docusaurus.io/docs/i18n/introduction) is used for caswaf website's translation.
Please note that some sentences do not require translation or need to be translated according to our regulations:
- 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)).
- You may see some sentences containing `{}`, like:
```text
At our {repoLink}, browse and submit {issueLink} or {prLink} for bugs you find or any new features you may want implemented.
```
Please do not translate `{repoLink}` or `{issueLink}` or any similar words, they are [interpolation placeholders](https://docusaurus.io/docs/docusaurus-core#translate-props).
- Please don't translate sentences like `authors: [caswaf]`.
### Website Development
See [Creating Pages](https://docusaurus.io/docs/creating-pages) to learn how to create a page.
See [Styling and Layout](https://docusaurus.io/docs/styling-layout) to learn how to modify styles.
See [Swizzling](https://docusaurus.io/docs/swizzling) to learn how to modify Docusaurus built-in components.
## LICENSE
[Apache-2.0 license](./LICENSE).