AtHeartEngineer/website
1
0
Fork 0
mirror of https://github.com/tlsnotary/website.git synced 2026-01-07 22:13:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Hendrik Eeckhaut
2025-05-19 14:02:57 +02:00
parent 9c819706ca
commit 52732e695b
1 changed files with 20 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@@ -1,56 +1,36 @@
# Website
# TLSNotary Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
This repository contains the source files for the TLSNotary website: https://tlsnotary.org
### Installation
```
$ yarn
```
The site is built using [Docusaurus](https://docusaurus.io/)
### Local Development
```
$ yarn start
```sh
npm ci
npm run start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
This starts a local development server and opens a browser window. Most changes are reflected live without needing to restart the server.
### Build
```
$ yarn build
Before submitting a PR, please make sure there are no warnings when you run:
```sh
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Diagrams
### Deployment
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.
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
https://docusaurus.io/docs/sidebar/autogenerated
https://mdxjs.com/playground/
Front matter:
https://docusaurus.io/docs/markdown-features#front-matter
https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter
### 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-scaling-explorations/maci/tree/dev/apps/website
* MPC: https://github.com/privacy-scaling-explorations/mpc-framework-website
* MPC: https://github.com/privacy-scaling-explorations/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.