Prepare docs application with minimal Narval brand (#211)

* Configure docs with Narval brand Rename project from documentation to docs. * Fix home page
narval-xyz · Apr 2, 2024 · e686215 · e686215
1 parent b2a5901
commit e686215
Show file tree

Hide file tree

Showing 54 changed files with 458 additions and 1,611 deletions.
diff --git a/Makefile b/Makefile
@@ -1,5 +1,6 @@
 include ./apps/armory/Makefile
 include ./apps/devtool/Makefile
+include ./apps/docs/Makefile
 include ./apps/policy-engine/Makefile
 include ./apps/vault/Makefile
 include ./packages/nestjs-shared/Makefile

diff --git a/apps/documentation/.gitignore → apps/docs/.gitignore b/apps/documentation/.gitignore → apps/docs/.gitignore
diff --git a/apps/docs/Makefile b/apps/docs/Makefile
@@ -0,0 +1,4 @@
+DOCS_PROJECT_NAME := docs
+
+docs/start/dev:
+	npx nx serve ${DOCS_PROJECT_NAME} --verbose
diff --git a/apps/documentation/README.md → apps/docs/README.md b/apps/documentation/README.md → apps/docs/README.md
diff --git a/apps/documentation/babel.config.js → apps/docs/babel.config.js b/apps/documentation/babel.config.js → apps/docs/babel.config.js
diff --git a/apps/docs/docs/getting-started/_category_.json b/apps/docs/docs/getting-started/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Getting Started",
+  "position": 1
+}
diff --git a/apps/docs/docs/index.mdx b/apps/docs/docs/index.mdx
@@ -0,0 +1,12 @@
+---
+id: home
+sidebar_position: 0
+sidebar_class_name: display-none
+title: Introduction
+hide_title: true
+hide_table_of_contents: true
+custom_edit_url: null
+pagination_next: null
+---
+
+TBD
diff --git a/...tion/docs/tutorial-basics/_category_.json → ...docs/docs/tutorial-basics/_category_.json b/...tion/docs/tutorial-basics/_category_.json → ...docs/docs/tutorial-basics/_category_.json
diff --git a/...n/docs/tutorial-basics/congratulations.md → ...s/docs/tutorial-basics/congratulations.md b/...n/docs/tutorial-basics/congratulations.md → ...s/docs/tutorial-basics/congratulations.md
diff --git a/...ocs/tutorial-basics/create-a-blog-post.md → ...ocs/tutorial-basics/create-a-blog-post.md b/...ocs/tutorial-basics/create-a-blog-post.md → ...ocs/tutorial-basics/create-a-blog-post.md
diff --git a/...docs/tutorial-basics/create-a-document.md → ...docs/tutorial-basics/create-a-document.md b/...docs/tutorial-basics/create-a-document.md → ...docs/tutorial-basics/create-a-document.md
diff --git a/...ion/docs/tutorial-basics/create-a-page.md → ...ocs/docs/tutorial-basics/create-a-page.md b/...ion/docs/tutorial-basics/create-a-page.md → ...ocs/docs/tutorial-basics/create-a-page.md
diff --git a/...ics/debugging-redis-with-redis-insight.md → ...ics/debugging-redis-with-redis-insight.md b/...ics/debugging-redis-with-redis-insight.md → ...ics/debugging-redis-with-redis-insight.md
@@ -11,7 +11,6 @@ Docker image, and can be used to inspect the contents of your Redis database.
 
 You can then access Redis Insight at http://localhost:8001.
 
-> [!IMPORTANT]
 > When adding a new connection, use the hostname of the host machine, not
 > `localhost`.
 > If you're on macOS, use `host.docker.internal`.
diff --git a/.../docs/tutorial-basics/deploy-your-site.md → .../docs/tutorial-basics/deploy-your-site.md b/.../docs/tutorial-basics/deploy-your-site.md → .../docs/tutorial-basics/deploy-your-site.md
diff --git a/...ocs/tutorial-basics/markdown-features.mdx → ...ocs/tutorial-basics/markdown-features.mdx b/...ocs/tutorial-basics/markdown-features.mdx → ...ocs/tutorial-basics/markdown-features.mdx
diff --git a/...tion/docs/tutorial-extras/_category_.json → ...docs/docs/tutorial-extras/_category_.json b/...tion/docs/tutorial-extras/_category_.json → ...docs/docs/tutorial-extras/_category_.json
diff --git a/...torial-extras/img/docsVersionDropdown.png → ...torial-extras/img/docsVersionDropdown.png b/...torial-extras/img/docsVersionDropdown.png → ...torial-extras/img/docsVersionDropdown.png
diff --git a/...cs/tutorial-extras/img/localeDropdown.png → ...cs/tutorial-extras/img/localeDropdown.png b/...cs/tutorial-extras/img/localeDropdown.png → ...cs/tutorial-extras/img/localeDropdown.png
diff --git a/...s/tutorial-extras/manage-docs-versions.md → ...s/tutorial-extras/manage-docs-versions.md b/...s/tutorial-extras/manage-docs-versions.md → ...s/tutorial-extras/manage-docs-versions.md
diff --git a/...cs/tutorial-extras/translate-your-site.md → ...cs/tutorial-extras/translate-your-site.md b/...cs/tutorial-extras/translate-your-site.md → ...cs/tutorial-extras/translate-your-site.md
diff --git a/apps/docs/docusaurus.config.ts b/apps/docs/docusaurus.config.ts
@@ -0,0 +1,64 @@
+import type * as Preset from '@docusaurus/preset-classic'
+import type { Config } from '@docusaurus/types'
+import { themes as prismThemes } from 'prism-react-renderer'
+
+const config: Config = {
+  title: 'Armory - Documentation',
+  tagline: 'Unicorn whales are cool',
+  favicon: 'img/favicon.ico',
+
+  url: 'https://docs.narval.xyz',
+  baseUrl: '/',
+
+  organizationName: 'narval-xyz',
+  projectName: 'armory',
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en']
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          routeBasePath: '/',
+          sidebarPath: './sidebars.ts'
+        },
+        blog: false,
+        theme: {
+          customCss: './src/css/custom.css'
+        }
+      } satisfies Preset.Options
+    ]
+  ],
+
+  themeConfig: {
+    image: 'img/docusaurus-social-card.jpg',
+    navbar: {
+      title: 'for Developers',
+      logo: {
+        alt: 'Narval logo',
+        src: 'img/logo.svg',
+        srcDark: 'img/logo-white.svg'
+      },
+      items: [
+        {
+          href: 'https://github.com/narval-xyz',
+          label: 'GitHub',
+          position: 'right'
+        }
+      ]
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula
+    }
+  } satisfies Preset.ThemeConfig
+}
+
+export default config
diff --git a/apps/documentation/project.json → apps/docs/project.json b/apps/documentation/project.json → apps/docs/project.json
@@ -1,13 +1,13 @@
 {
-  "name": "documentation",
+  "name": "docs",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "projectType": "application",
-  "sourceRoot": "apps/documentation/src",
+  "sourceRoot": "apps/docs/src",
   "targets": {
     "build": {
       "executor": "@nx-plus/docusaurus:browser",
       "options": {
-        "outputPath": "dist/apps/documentation"
+        "outputPath": "dist/apps/docs"
       }
     },
     "serve": {

diff --git a/apps/docs/sidebars.ts b/apps/docs/sidebars.ts
@@ -0,0 +1,7 @@
+import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'
+
+const sidebars: SidebarsConfig = {
+  docsSiderbar: [{ type: 'autogenerated', dirName: '.' }]
+}
+
+export default sidebars
diff --git a/...src/components/HomepageFeatures/index.tsx → ...src/components/HomepageFeatures/index.tsx b/...src/components/HomepageFeatures/index.tsx → ...src/components/HomepageFeatures/index.tsx
diff --git a/...onents/HomepageFeatures/styles.module.css → ...onents/HomepageFeatures/styles.module.css b/...onents/HomepageFeatures/styles.module.css → ...onents/HomepageFeatures/styles.module.css
diff --git a/apps/docs/src/css/custom.css b/apps/docs/src/css/custom.css
@@ -0,0 +1,53 @@
+@import url('https://fonts.googleapis.com/css2?family=Inter:wght@100;200;300;400;500;600;700;800;900&display=swap');
+@import url('https://fonts.googleapis.com/css2?family=Roboto+Mono&display=swap');
+@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Mono&display=swap');
+
+/* You can override the default Infima variables here. */
+:root {
+  --ifm-global-radius: 8px;
+  --ifm-code-font-size: 14px;
+  --ifm-font-family-base: 'Inter', BlinkMacSystemFont, -apple-system, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu',
+    'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 'Helvetica', 'Arial', sans-serif;
+  --ifm-font-family-monospace: 'Roboto Mono', SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New',
+    monospace;
+  --ifm-font-size-base: 14px;
+  --ifm-base-spacing: 14px;
+  --ifm-line-height-base: 145%;
+  --ifm-font-weight-base: var(--twenty-body-regular-font-weight);
+  --ifm-color-primary: #11181c;
+  --ifm-code-font-size: 95%;
+  --docsearch-key-gradient: none !important;
+  --docsearch-key-shadow: 0 0 0 0.5px var(--docsearch-muted-color) !important;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+  --ifm-toc-padding-vertical: 0.5rem;
+  --ifm-breadcrumb-border-radius: 8px;
+  --ifm-navbar-link-color: #687076;
+  --ifm-link-decoration: underline;
+
+  --ifm-heading-font-weight: 600;
+
+  --ifm-h1-font-size: 1.7rem !important;
+  --ifm-h2-font-size: 1.25rem !important;
+  --ifm-h3-font-size: 1rem !important;
+  --ifm-h4-font-size: 0.875rem !important;
+  --ifm-h5-font-size: 0.85rem !important;
+
+  --ifm-spacing-horizontal: 2rem;
+
+  --ifm-menu-link-padding-vertical: 0.2rem;
+
+  --list-items-border-color: #ebebeb;
+  --category-icon-background-color: #ebebeb;
+  --category-icon-border-color: #d6d6d6;
+  --level-1-color: #b3b3b3;
+}
+
+/* For readability concerns, you should choose a lighter palette in dark mode. */
+[data-theme='dark'] {
+  --ifm-color-primary: #fff;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+  --list-items-border-color: #292929;
+  --category-icon-background-color: #292929;
+  --category-icon-border-color: #333333;
+  --level-1-color: #666666;
+}
diff --git a/apps/documentation/static/.nojekyll → apps/docs/static/.nojekyll b/apps/documentation/static/.nojekyll → apps/docs/static/.nojekyll
diff --git a/...ion/static/img/docusaurus-social-card.jpg → ...ocs/static/img/docusaurus-social-card.jpg b/...ion/static/img/docusaurus-social-card.jpg → ...ocs/static/img/docusaurus-social-card.jpg
diff --git a/apps/documentation/static/img/docusaurus.png → apps/docs/static/img/docusaurus.png b/apps/documentation/static/img/docusaurus.png → apps/docs/static/img/docusaurus.png
diff --git a/apps/docs/static/img/favicon.ico b/apps/docs/static/img/favicon.ico
diff --git a/apps/docs/static/img/logo-white.svg b/apps/docs/static/img/logo-white.svg
diff --git a/apps/docs/static/img/logo.svg b/apps/docs/static/img/logo.svg
diff --git a/...static/img/undraw_docusaurus_mountain.svg → ...static/img/undraw_docusaurus_mountain.svg b/...static/img/undraw_docusaurus_mountain.svg → ...static/img/undraw_docusaurus_mountain.svg
diff --git a/...on/static/img/undraw_docusaurus_react.svg → ...cs/static/img/undraw_docusaurus_react.svg b/...on/static/img/undraw_docusaurus_react.svg → ...cs/static/img/undraw_docusaurus_react.svg
diff --git a/...ion/static/img/undraw_docusaurus_tree.svg → ...ocs/static/img/undraw_docusaurus_tree.svg b/...ion/static/img/undraw_docusaurus_tree.svg → ...ocs/static/img/undraw_docusaurus_tree.svg
diff --git a/apps/documentation/tsconfig.json → apps/docs/tsconfig.json b/apps/documentation/tsconfig.json → apps/docs/tsconfig.json
diff --git a/apps/documentation/blog/2019-05-28-first-blog-post.md b/apps/documentation/blog/2019-05-28-first-blog-post.md
diff --git a/apps/documentation/blog/2019-05-29-long-blog-post.md b/apps/documentation/blog/2019-05-29-long-blog-post.md
diff --git a/apps/documentation/blog/2021-08-01-mdx-blog-post.mdx b/apps/documentation/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/apps/documentation/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/apps/documentation/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/apps/documentation/blog/2021-08-26-welcome/index.md b/apps/documentation/blog/2021-08-26-welcome/index.md
diff --git a/apps/documentation/blog/authors.yml b/apps/documentation/blog/authors.yml
diff --git a/apps/documentation/docs/intro.md b/apps/documentation/docs/intro.md