From c47347ff76f115f56676f5ecad0032bfcb98a03d Mon Sep 17 00:00:00 2001 From: Xe Iaso Date: Thu, 20 Mar 2025 15:06:58 -0400 Subject: add docs site based on docusarus (#35) * add docs site based on docusarus Closes #2 Signed-off-by: Xe Iaso * docs: deploy to aeacus Signed-off-by: Xe Iaso * ready for merge Signed-off-by: Xe Iaso * docs: fix anubis port Signed-off-by: Xe Iaso --------- Signed-off-by: Xe Iaso --- docs/.dockerignore | 23 + docs/.gitignore | 20 + docs/Dockerfile | 10 + docs/README.md | 41 + docs/blog/2019-05-28-first-blog-post.md | 12 + docs/blog/2019-05-29-long-blog-post.md | 44 + docs/blog/2021-08-01-mdx-blog-post.mdx | 24 + .../docusaurus-plushie-banner.jpeg | Bin 0 -> 96122 bytes docs/blog/2021-08-26-welcome/index.md | 29 + docs/blog/authors.yml | 23 + docs/blog/tags.yml | 19 + docs/docs/CHANGELOG.md | 31 + docs/docs/admin/_category_.json | 8 + docs/docs/admin/caveats-gitea-forgejo.mdx | 34 + docs/docs/design/_category_.json | 8 + docs/docs/design/how-anubis-works.mdx | 121 + docs/docs/index.mdx | 28 + docs/docs/installation.mdx | 135 + docs/docs/policies.md | 81 + docs/docusaurus.config.ts | 158 + docs/manifest/deployment.yaml | 57 + docs/manifest/ingress.yaml | 24 + docs/manifest/kustomization.yaml | 5 + docs/manifest/onionservice.yaml | 14 + docs/manifest/service.yaml | 14 + docs/package-lock.json | 19265 +++++++++++++++++++ docs/package.json | 48 + docs/policies.md | 77 - docs/sidebars.ts | 33 + docs/src/components/HomepageFeatures/index.tsx | 72 + .../components/HomepageFeatures/styles.module.css | 11 + docs/src/css/custom.css | 69 + docs/src/pages/index.module.css | 23 + docs/src/pages/index.tsx | 43 + docs/static/.nojekyll | 0 docs/static/img/android-chrome-512x512.png | Bin 0 -> 224183 bytes docs/static/img/docusaurus-social-card.jpg | Bin 0 -> 55746 bytes docs/static/img/docusaurus.png | Bin 0 -> 5142 bytes docs/static/img/favicon.ico | Bin 0 -> 15406 bytes docs/static/img/happy.webp | Bin 0 -> 60572 bytes docs/static/img/logo.svg | 1 + docs/static/img/undraw_docusaurus_mountain.svg | 171 + docs/static/img/undraw_docusaurus_react.svg | 170 + docs/static/img/undraw_docusaurus_tree.svg | 40 + docs/tsconfig.json | 8 + 45 files changed, 20917 insertions(+), 77 deletions(-) create mode 100644 docs/.dockerignore create mode 100644 docs/.gitignore create mode 100644 docs/Dockerfile create mode 100644 docs/README.md create mode 100644 docs/blog/2019-05-28-first-blog-post.md create mode 100644 docs/blog/2019-05-29-long-blog-post.md create mode 100644 docs/blog/2021-08-01-mdx-blog-post.mdx create mode 100644 docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg create mode 100644 docs/blog/2021-08-26-welcome/index.md create mode 100644 docs/blog/authors.yml create mode 100644 docs/blog/tags.yml create mode 100644 docs/docs/CHANGELOG.md create mode 100644 docs/docs/admin/_category_.json create mode 100644 docs/docs/admin/caveats-gitea-forgejo.mdx create mode 100644 docs/docs/design/_category_.json create mode 100644 docs/docs/design/how-anubis-works.mdx create mode 100644 docs/docs/index.mdx create mode 100644 docs/docs/installation.mdx create mode 100644 docs/docs/policies.md create mode 100644 docs/docusaurus.config.ts create mode 100644 docs/manifest/deployment.yaml create mode 100644 docs/manifest/ingress.yaml create mode 100644 docs/manifest/kustomization.yaml create mode 100644 docs/manifest/onionservice.yaml create mode 100644 docs/manifest/service.yaml create mode 100644 docs/package-lock.json create mode 100644 docs/package.json delete mode 100644 docs/policies.md create mode 100644 docs/sidebars.ts create mode 100644 docs/src/components/HomepageFeatures/index.tsx create mode 100644 docs/src/components/HomepageFeatures/styles.module.css create mode 100644 docs/src/css/custom.css create mode 100644 docs/src/pages/index.module.css create mode 100644 docs/src/pages/index.tsx create mode 100644 docs/static/.nojekyll create mode 100644 docs/static/img/android-chrome-512x512.png create mode 100644 docs/static/img/docusaurus-social-card.jpg create mode 100644 docs/static/img/docusaurus.png create mode 100644 docs/static/img/favicon.ico create mode 100644 docs/static/img/happy.webp create mode 100644 docs/static/img/logo.svg create mode 100644 docs/static/img/undraw_docusaurus_mountain.svg create mode 100644 docs/static/img/undraw_docusaurus_react.svg create mode 100644 docs/static/img/undraw_docusaurus_tree.svg create mode 100644 docs/tsconfig.json (limited to 'docs') diff --git a/docs/.dockerignore b/docs/.dockerignore new file mode 100644 index 0000000..13ad2b9 --- /dev/null +++ b/docs/.dockerignore @@ -0,0 +1,23 @@ +# Dependencies +/node_modules + +# Production +/build + +# Generated files +.docusaurus +.cache-loader + +# Misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Kubernetes manifests +/manifest \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..b2d6de3 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,20 @@ +# Dependencies +/node_modules + +# Production +/build + +# Generated files +.docusaurus +.cache-loader + +# Misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 0000000..0faa826 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,10 @@ +FROM node AS build + +WORKDIR /app +COPY . . + +RUN npm ci && npm run build + +FROM nginx:alpine +COPY --from=build /app/build /usr/share/nginx/html +LABEL org.opencontainers.image.source="https://github.com/TecharoHQ/anubis" \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..0c6c2c2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,41 @@ +# Website + +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. + +### Installation + +``` +$ yarn +``` + +### Local Development + +``` +$ yarn 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. + +### Build + +``` +$ yarn build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +### Deployment + +Using SSH: + +``` +$ USE_SSH=true yarn deploy +``` + +Not using SSH: + +``` +$ GIT_USER= 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. diff --git a/docs/blog/2019-05-28-first-blog-post.md b/docs/blog/2019-05-28-first-blog-post.md new file mode 100644 index 0000000..d3032ef --- /dev/null +++ b/docs/blog/2019-05-28-first-blog-post.md @@ -0,0 +1,12 @@ +--- +slug: first-blog-post +title: First Blog Post +authors: [slorber, yangshun] +tags: [hola, docusaurus] +--- + +Lorem ipsum dolor sit amet... + + + +...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/docs/blog/2019-05-29-long-blog-post.md b/docs/blog/2019-05-29-long-blog-post.md new file mode 100644 index 0000000..eb4435d --- /dev/null +++ b/docs/blog/2019-05-29-long-blog-post.md @@ -0,0 +1,44 @@ +--- +slug: long-blog-post +title: Long Blog Post +authors: yangshun +tags: [hello, docusaurus] +--- + +This is the summary of a very long blog post, + +Use a `` comment to limit blog post size in the list view. + + + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/docs/blog/2021-08-01-mdx-blog-post.mdx b/docs/blog/2021-08-01-mdx-blog-post.mdx new file mode 100644 index 0000000..0c4b4a4 --- /dev/null +++ b/docs/blog/2021-08-01-mdx-blog-post.mdx @@ -0,0 +1,24 @@ +--- +slug: mdx-blog-post +title: MDX Blog Post +authors: [slorber] +tags: [docusaurus] +--- + +Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). + +:::tip + +Use the power of React to create interactive blog posts. + +::: + +{/* truncate */} + +For example, use JSX to create an interactive button: + +```js + +``` + + diff --git a/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg new file mode 100644 index 0000000..11bda09 Binary files /dev/null and b/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg differ diff --git a/docs/blog/2021-08-26-welcome/index.md b/docs/blog/2021-08-26-welcome/index.md new file mode 100644 index 0000000..349ea07 --- /dev/null +++ b/docs/blog/2021-08-26-welcome/index.md @@ -0,0 +1,29 @@ +--- +slug: welcome +title: Welcome +authors: [slorber, yangshun] +tags: [facebook, hello, docusaurus] +--- + +[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog). + +Here are a few tips you might find useful. + + + +Simply add Markdown files (or folders) to the `blog` directory. + +Regular blog authors can be added to `authors.yml`. + +The blog post date can be extracted from filenames, such as: + +- `2019-05-30-welcome.md` +- `2019-05-30-welcome/index.md` + +A blog post folder can be convenient to co-locate blog post images: + +![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg) + +The blog supports tags as well! + +**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config. diff --git a/docs/blog/authors.yml b/docs/blog/authors.yml new file mode 100644 index 0000000..8bfa5c7 --- /dev/null +++ b/docs/blog/authors.yml @@ -0,0 +1,23 @@ +yangshun: + name: Yangshun Tay + title: Front End Engineer @ Facebook + url: https://github.com/yangshun + image_url: https://github.com/yangshun.png + page: true + socials: + x: yangshunz + github: yangshun + +slorber: + name: Sébastien Lorber + title: Docusaurus maintainer + url: https://sebastienlorber.com + image_url: https://github.com/slorber.png + page: + # customize the url of the author page at /blog/authors/ + permalink: '/all-sebastien-lorber-articles' + socials: + x: sebastienlorber + linkedin: sebastienlorber + github: slorber + newsletter: https://thisweekinreact.com diff --git a/docs/blog/tags.yml b/docs/blog/tags.yml new file mode 100644 index 0000000..bfaa778 --- /dev/null +++ b/docs/blog/tags.yml @@ -0,0 +1,19 @@ +facebook: + label: Facebook + permalink: /facebook + description: Facebook tag description + +hello: + label: Hello + permalink: /hello + description: Hello tag description + +docusaurus: + label: Docusaurus + permalink: /docusaurus + description: Docusaurus tag description + +hola: + label: Hola + permalink: /hola + description: Hola tag description diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md new file mode 100644 index 0000000..2015670 --- /dev/null +++ b/docs/docs/CHANGELOG.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 999 +--- + +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +- Documentation has been moved to https://anubis.techaro.lol/ with sources in docs/ + +## 1.13.0 + +- Proof-of-work challenges are drastically sped up [#19](https://github.com/TecharoHQ/anubis/pull/19) +- Docker images are now built with the timestamp set to the commit timestamp +- The README now points to TecharoHQ/anubis instead of Xe/x +- Images are built using ko instead of `docker buildx build` + [#13](https://github.com/TecharoHQ/anubis/pull/13) + +## 1.12.1 + +- Phrasing in the `