mirror of
https://github.com/tlsnotary/website.git
synced 2026-01-06 20:53:56 -05:00
37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# TLSNotary Website
|
|
|
|
This repository contains the source files for the TLSNotary website: https://tlsnotary.org
|
|
|
|
The site is built using [Docusaurus](https://docusaurus.io/)
|
|
|
|
### Local Development
|
|
|
|
```sh
|
|
npm ci
|
|
npm run start
|
|
```
|
|
|
|
This starts a local development server and opens a browser window. Most changes are reflected live without needing to restart the server.
|
|
|
|
Before submitting a PR, please make sure there are no warnings when you run:
|
|
```sh
|
|
npm run build
|
|
```
|
|
|
|
### Diagrams
|
|
|
|
All diagrams are created using draw.io. The diagram source files are stored in the diagrams folder.
|
|
“Before use, each diagram must be converted to both light and dark SVG versions with the `convert_all.sh` script in the same folder.
|
|
|
|
### Useful Docusaurus links
|
|
|
|
* Sidebar: https://docusaurus.io/docs/sidebar/autogenerated
|
|
* MDX: https://mdxjs.com/playground/
|
|
* Front matter: https://docusaurus.io/docs/markdown-features#front-matter
|
|
|
|
Other Docusaurus websites at PSE:
|
|
* MACI: https://github.com/privacy-ethereum/maci/tree/main/apps/website
|
|
* MPC: https://github.com/privacy-ethereum/mpc-framework-website
|
|
|
|
> **Disclaimer**: While we appreciate all contributions, we do not prioritize minor grammatical fixes (e.g., correcting typos or rewording sentences) unless they significantly improve clarity in technical documentation. These contributions can be a distraction for the team. If you notice a grammatical error, please let us know on our Discord.
|