Skip to content
This repository was archived by the owner on Aug 27, 2024. It is now read-only.

Commit 12b1159

Browse files
authored
docs: Provide a new documentation template (#144)
* Provide a new documentation template * 💚 add netlify config * ✨ update docs * 🐛 deploy preview index.html fix * 👌 Fix docs + netlify app ID
1 parent 1cee1c6 commit 12b1159

25 files changed

+27369
-336
lines changed

.gitignore

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ ClientBin/
222222
*.publishsettings
223223
orleans.codegen.cs
224224

225-
# Including strong name files can present a security risk
225+
# Including strong name files can present a security risk
226226
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
227227
#*.snk
228228

@@ -318,7 +318,7 @@ __pycache__/
318318
# OpenCover UI analysis results
319319
OpenCover/
320320

321-
# Azure Stream Analytics local run output
321+
# Azure Stream Analytics local run output
322322
ASALocalRun/
323323

324324
# MSBuild Binary and Structured Log
@@ -327,10 +327,15 @@ ASALocalRun/
327327
# NVidia Nsight GPU debugger configuration file
328328
*.nvuser
329329

330-
# MFractors (Xamarin productivity tool) working folder
330+
# MFractors (Xamarin productivity tool) working folder
331331
.mfractor/
332332
**/Open-Api-Docs.xml
333333
/docs/_site
334334
**/docker-compose.override.yml
335335
**/appsettings.Development.json
336336
**/appsettings.local.json
337+
338+
# Docusaurus
339+
docs/.docusaurus
340+
docs/node_modules
341+
docs/build

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/Gemfile

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/Gemfile.lock

Lines changed: 0 additions & 284 deletions
This file was deleted.

docs/README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,52 @@
1-
Documentation
2-
====
1+
# Website
32

4-
All documentation for Arcus Event Grid Proxy which are published via GitHub Pages with Jekyll.
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
54

6-
## Running Jekyll locally
5+
## Prerequisites
6+
This documentation assumes that you run all scripts within the docs folder.
77

8-
Running Jekyll locally to test your changes is super easy, learn more about it [here](https://jekyllrb.com/docs/#instructions).
8+
```console
9+
cd docs
10+
```
11+
12+
## Installation
13+
14+
```console
15+
npm install
16+
```
17+
18+
## Local Development
19+
20+
```console
21+
npm start
22+
```
23+
24+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
25+
26+
## Versioning
27+
https://docusaurus.io/docs/versioning
28+
29+
You can use the version script to create a new documentation version based on the latest content in the `./preview` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.
30+
31+
### Tagging a new version
32+
33+
1. First, make sure your content in the `./preview` directory is ready to be frozen as a version. A version always should be based from master.
34+
2. Enter a new version number:
35+
36+
`npm run docusaurus docs:version 1.1.0`
37+
38+
---
39+
When tagging a new version, the document versioning mechanism will:
40+
41+
- Copy the full `./preview` folder contents into a new `versioned_docs/version-<version>/` folder.
42+
- Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as `versioned_sidebars/version-<version>-sidebars.json`.
43+
- Append the new version number to `versions.json`.
44+
45+
## Syntax higlighting
46+
47+
To have syntax highlighting within the codeblocks you have to use one of the prism supported languages:
48+
49+
https://github.com/FormidableLabs/prism-react-renderer/blob/master/src/vendor/prism/includeLangs.js
50+
## Deploying to Netlify
51+
52+
https://docusaurus.io/docs/deployment#deploying-to-netlify

docs/_config.yml

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)