Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare docs application with minimal Narval brand #211

Merged
merged 2 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Expand Down
File renamed without changes.
4 changes: 4 additions & 0 deletions apps/docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
DOCS_PROJECT_NAME := docs

docs/start/dev:
npx nx serve ${DOCS_PROJECT_NAME} --verbose
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions apps/docs/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Getting Started",
"position": 1
}
12 changes: 12 additions & 0 deletions apps/docs/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
64 changes: 64 additions & 0 deletions apps/docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions apps/documentation/project.json → apps/docs/project.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
7 changes: 7 additions & 0 deletions apps/docs/sidebars.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'

const sidebars: SidebarsConfig = {
docsSiderbar: [{ type: 'autogenerated', dirName: '.' }]
}

export default sidebars
53 changes: 53 additions & 0 deletions apps/docs/src/css/custom.css
Original file line number Diff line number Diff line change
@@ -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;
}
File renamed without changes.
Binary file added apps/docs/static/img/favicon.ico
Binary file not shown.
14 changes: 14 additions & 0 deletions apps/docs/static/img/logo-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions apps/docs/static/img/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
12 changes: 0 additions & 12 deletions apps/documentation/blog/2019-05-28-first-blog-post.md

This file was deleted.

44 changes: 0 additions & 44 deletions apps/documentation/blog/2019-05-29-long-blog-post.md

This file was deleted.

20 changes: 0 additions & 20 deletions apps/documentation/blog/2021-08-01-mdx-blog-post.mdx

This file was deleted.

Binary file not shown.
25 changes: 0 additions & 25 deletions apps/documentation/blog/2021-08-26-welcome/index.md

This file was deleted.

17 changes: 0 additions & 17 deletions apps/documentation/blog/authors.yml

This file was deleted.

47 changes: 0 additions & 47 deletions apps/documentation/docs/intro.md

This file was deleted.

Loading