diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md index 02f3f81..b81bd15 100644 --- a/blog/2019-05-28-first-blog-post.md +++ b/blog/2019-05-28-first-blog-post.md @@ -2,11 +2,9 @@ slug: first-blog-post title: First Blog Post authors: - name: Gao Wei - title: Docusaurus Core Team - url: https://github.com/wgao19 - image_url: https://github.com/wgao19.png + name: Tine Jozelj 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/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md deleted file mode 100644 index 26ffb1b..0000000 --- a/blog/2019-05-29-long-blog-post.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: long-blog-post -title: Long Blog Post -authors: endi -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/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx deleted file mode 100644 index c04ebe3..0000000 --- a/blog/2021-08-01-mdx-blog-post.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -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. - -```js - -``` - - - -::: diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg deleted file mode 100644 index 11bda09..0000000 Binary files a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg and /dev/null differ diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md deleted file mode 100644 index 9455168..0000000 --- a/blog/2021-08-26-welcome/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -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). - -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/blog/authors.yml b/blog/authors.yml index bcb2991..fae0297 100644 --- a/blog/authors.yml +++ b/blog/authors.yml @@ -1,17 +1,5 @@ -endi: - name: Endilie Yacop Sucipto - title: Maintainer of Docusaurus - url: https://github.com/endiliey - image_url: https://github.com/endiliey.png - -yangshun: - name: Yangshun Tay - title: Front End Engineer @ Facebook - url: https://github.com/yangshun - image_url: https://github.com/yangshun.png - -slorber: - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png +mentos1386: + name: Tine Jozelj + title: Maintainer of tjo.space + url: https://github.com/mentos1386 + image_url: https://github.com/mentos1386.png diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/hardware.md b/docs/hardware.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/home.md b/docs/home.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index 8a2e69d..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -### What you'll need - -- [Node.js](https://nodejs.org/en/download/) version 16.14 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55..0000000 --- a/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/tutorial-basics/congratulations.md b/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/tutorial-basics/create-a-blog-post.md b/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index ea472bb..0000000 --- a/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index ffddfa8..0000000 --- a/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -module.exports = { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/tutorial-basics/create-a-page.md b/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/docs/tutorial-basics/deploy-your-site.md b/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/tutorial-basics/markdown-features.mdx b/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 42726be..0000000 --- a/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - - ```jsx title="src/components/HelloDocusaurus.js" - function HelloDocusaurus() { - return ( -

Hello, Docusaurus!

- ) - } - ``` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - - :::tip My tip - - Use this awesome feature option - - ::: - - :::danger Take care - - This action is dangerous - - ::: - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs/tutorial-extras/_category_.json b/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc1..0000000 --- a/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164..0000000 Binary files a/docs/tutorial-extras/img/docsVersionDropdown.png and /dev/null differ diff --git a/docs/tutorial-extras/img/localeDropdown.png b/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc..0000000 Binary files a/docs/tutorial-extras/img/localeDropdown.png and /dev/null differ diff --git a/docs/tutorial-extras/manage-docs-versions.md b/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index e12c3f3..0000000 --- a/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/tutorial-extras/translate-your-site.md b/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index caeaffb..0000000 --- a/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -module.exports = { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a same time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/docusaurus.config.js b/docusaurus.config.js index 371e432..868309b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -7,7 +7,7 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula"); /** @type {import('@docusaurus/types').Config} */ const config = { title: "tjo.space", - tagline: "Your local cloud ☁️", + tagline: "Your personal space.", favicon: "img/icon.svg", // Set the production url of your site here @@ -53,7 +53,7 @@ const config = { const { blogPosts, defaultCreateFeedItems, ...rest } = params; return defaultCreateFeedItems({ // keep only the 10 most recent blog posts in the feed - blogPosts: blogPosts.filter((item, index) => index < 10), + blogPosts: blogPosts.filter((_item, index) => index < 10), ...rest, }); }, @@ -83,19 +83,20 @@ const config = { /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ // Replace with your project's social card - image: "img/docusaurus-social-card.jpg", + image: "img/icon.svg", navbar: { title: "", logo: { alt: "tjo.space logo", - src: "img/logo.svg", + src: "img/logo-dark.svg", + srcDark: "img/logo-light.svg", }, items: [ { type: "docSidebar", - sidebarId: "tutorialSidebar", + sidebarId: "documentationSidebar", position: "left", - label: "Tutorial", + label: "Documentation", }, { to: "/blog", label: "Blog", position: "left" }, { @@ -105,14 +106,19 @@ const config = { ], }, footer: { - style: "dark", + style: "light", + logo: { src: "img/logo-dark.svg", srcDark: "img/logo-light.svg" }, links: [ { - title: "Docs", + title: "Articles", items: [ { - label: "Tutorial", - to: "/docs/intro", + label: "Documentation", + to: "/docs/home", + }, + { + label: "Blog", + to: "/blog", }, ], }, @@ -120,13 +126,9 @@ const config = { title: "Community", items: [ { - label: "Matrix Chat", + label: "Matrix Room #hello:tjo.space", href: "https://matrix.to/#/#hello:tjo.space", }, - { - label: "Public Source Code", - href: "https://code.tjo.space/tjo-space", - }, ], }, ], diff --git a/sidebars.js b/sidebars.js index 9ab54c2..d56b8ec 100644 --- a/sidebars.js +++ b/sidebars.js @@ -14,7 +14,7 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + documentationSidebar: [{ type: "autogenerated", dirName: "." }], // But you can create a sidebar manually /* diff --git a/src/components/HomepageFeatures/index.tsx b/src/components/HomepageFeatures/index.tsx index a0af062..2e2e595 100644 --- a/src/components/HomepageFeatures/index.tsx +++ b/src/components/HomepageFeatures/index.tsx @@ -2,136 +2,159 @@ import React from "react"; import clsx from "clsx"; import styles from "./styles.module.css"; +type ServicesSection = { + title: string; + description: string | JSX.Element; + services: ServiceItem[]; +}; + type ServiceItem = { title: string; Svg: React.ComponentType>; description: JSX.Element; }; -const PrivateServicesList: ServiceItem[] = [ - { - title: "Chat", - Svg: require("@site/static/img/undraw_chat_tjo_space.svg").default, - description: ( - <> - Use chat.tjo.space Metrix server - which you can use to chat with other users of tjo.space or world wide - with anyone else on the Matrix network. - - ), - }, - { - title: "Cloud", - Svg: require("@site/static/img/undraw_cloud_tjo_space.svg").default, - description: ( - <> - Use cloud.tjo.space Nextcloud - server as a personal cloud to store your Photos, Videos, - Files, Calendar, Contacts as well as share all that - with other users of tjo.space or anyone else. - - ), - }, - { - title: "Code", - Svg: require("@site/static/img/undraw_code_tjo_space.svg").default, - description: ( - <> - Use code.tjo.space Gitea server as - a Git repository and CI/CD system. - - ), - }, - { - title: "Paperless", - Svg: require("@site/static/img/undraw_paperless_tjo_space.svg").default, - description: ( - <> - Use paperless.tjo.space{" "} - Paperless server to archive your documents and make them searchable. Can - be connected to your email provider so that all attachments are - autmatically archived. - - ), - }, - { - title: "RSS", - Svg: require("@site/static/img/undraw_rss_tjo_space.svg").default, - description: ( - <> - Use rss.tjo.space server as a RSS - reader for all of your news, blogs and podcasts. - - ), - }, -]; +const PrivateServices: ServicesSection = { + title: "PrivateServices", + description: ( + <> + Services that require tjo.space account. + + ), + services: [ + { + title: "Chat", + Svg: require("@site/static/img/undraw_chat_tjo_space.svg").default, + description: ( + <> + Use chat.tjo.space Metrix server + which you can use to chat with other users of tjo.space or world wide + with anyone else on the Matrix network. + + ), + }, + { + title: "Cloud", + Svg: require("@site/static/img/undraw_cloud_tjo_space.svg").default, + description: ( + <> + Use cloud.tjo.space Nextcloud + server as a personal cloud to store your Photos, Videos, + Files, Calendar, Contacts as well as share all + that with other users of tjo.space or anyone else. + + ), + }, + { + title: "Code", + Svg: require("@site/static/img/undraw_code_tjo_space.svg").default, + description: ( + <> + Use code.tjo.space Gitea server + as a Git repository and CI/CD system. + + ), + }, + { + title: "Paperless", + Svg: require("@site/static/img/undraw_paperless_tjo_space.svg").default, + description: ( + <> + Use paperless.tjo.space{" "} + Paperless server to archive your documents and make them searchable. + Can be connected to your email provider so that all attachments are + autmatically archived. + + ), + }, + { + title: "RSS", + Svg: require("@site/static/img/undraw_rss_tjo_space.svg").default, + description: ( + <> + Use rss.tjo.space server as a RSS + reader for all of your news, blogs and podcasts. + + ), + }, + ], +}; -const PublicServicesList: ServiceItem[] = [ - { - title: "Search", - Svg: require("@site/static/img/undraw_search_tjo_space.svg").default, - description: ( - <> - Use search.tjo.space private meta - search engine that doesn't track you. - - ), - }, - { - title: "Send", - Svg: require("@site/static/img/undraw_send_tjo_space.svg").default, - description: ( - <> - Use send.tjo.space to create - private temporary link to share files up to 20GB in size. - - ), - }, - { - title: "Watch", - Svg: require("@site/static/img/undraw_yt_tjo_space.svg").default, - description: ( - <> - Use yt.tjo.space an Invidious server - to privatly watch YouTube videos. - - ), - }, -]; +const PublicServices: ServicesSection = { + title: "Public Services", + description: "Services that are available to everyone.", + services: [ + { + title: "Search", + Svg: require("@site/static/img/undraw_search_tjo_space.svg").default, + description: ( + <> + Use search.tjo.space private + meta search engine that doesn't track you. + + ), + }, + { + title: "Send", + Svg: require("@site/static/img/undraw_send_tjo_space.svg").default, + description: ( + <> + Use send.tjo.space to create + private temporary link to share files up to 20GB in size. + + ), + }, + { + title: "Watch", + Svg: require("@site/static/img/undraw_yt_tjo_space.svg").default, + description: ( + <> + Use yt.tjo.space an Invidious + server to privatly watch YouTube videos. + + ), + }, + ], +}; -const UpcomingServicesList: ServiceItem[] = [ - { - title: "Mail", - Svg: require("@site/static/img/undraw_mail_tjo_space.svg").default, - description: ( - <> - Use mail.tjo.space to get your - personal @tjo.space email address. - - ), - }, - { - title: "Vault", - Svg: require("@site/static/img/undraw_vault_tjo_space.svg").default, - description: ( - <> - Use vault.tjo.space Bitwarden - server to securily store your passwords. - - ), - }, - { - title: "VPN", - Svg: require("@site/static/img/undraw_vpn_tjo_space.svg").default, - description: ( - <> - Use vpn.tjo.space Tailscale server - to securily connect with other tjo.space users or use one of available - exit locations to have secure internet connection. - - ), - }, -]; +const UpcomingServices: ServicesSection = { + title: "Upcoming Services", + description: + "Services that we plan to provide in the future, but are not quite ready yet.", + services: [ + { + title: "Mail", + Svg: require("@site/static/img/undraw_mail_tjo_space.svg").default, + description: ( + <> + Use mail.tjo.space to get your + personal @tjo.space email address. + + ), + }, + { + title: "Vault", + Svg: require("@site/static/img/undraw_vault_tjo_space.svg").default, + description: ( + <> + Use vault.tjo.space Bitwarden + server to securily store your passwords. + + ), + }, + { + title: "VPN", + Svg: require("@site/static/img/undraw_vpn_tjo_space.svg").default, + description: ( + <> + Use vpn.tjo.space Tailscale server + to securily connect with other tjo.space users or use one of available + exit locations to have secure internet connection. + + ), + }, + ], +}; function Service({ title, Svg, description }: ServiceItem) { return ( @@ -151,24 +174,22 @@ export default function HomepageFeatures(): JSX.Element { return (
-

Public Services (available to everyone)

-
- {PublicServicesList.map((props, idx) => ( - - ))} -
-

Private Services (need an tjo.space account)

-
- {PrivateServicesList.map((props, idx) => ( - - ))} -
-

Upcoming Services (not yet available)

-
- {UpcomingServicesList.map((props, idx) => ( - - ))} -
+

Services that we provide

+ {[PublicServices, PrivateServices, UpcomingServices].map( + ({ title, description, services }) => { + return ( + <> +

{title}

+

{description}

+
+ {services.map((props, idx) => ( + + ))} +
+ + ); + } + )}
); diff --git a/src/components/HomepageFeatures/styles.module.css b/src/components/HomepageFeatures/styles.module.css index f7ea125..bf488c1 100644 --- a/src/components/HomepageFeatures/styles.module.css +++ b/src/components/HomepageFeatures/styles.module.css @@ -5,6 +5,16 @@ width: 100%; } +.featureHeader { + margin-top: 3rem; + text-align: center; +} + +.featureSubHeader { + text-align: center; + font-weight: normal; +} + .row { justify-content: center; } diff --git a/src/pages/index.module.css b/src/pages/index.module.css index 8f3bfe4..ab8a661 100644 --- a/src/pages/index.module.css +++ b/src/pages/index.module.css @@ -25,3 +25,17 @@ .buttons > :not(:first-child) { margin-left: 1rem; } + +.description { + text-align:center; + margin-top: 4rem; +} + +.descriptionLink { + color: var(--ifm-hero-text-color); + text-decoration: underline; +} + +.descriptionLink:hover { + color: var(--ifm-hero-text-color); +} diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 72303f6..5e5e1bc 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -9,10 +9,12 @@ import styles from "./index.module.css"; function HomepageHeader() { const { siteConfig } = useDocusaurusContext(); + const Logo = require("@site/static/img/logo-light.svg").default; + return (
-

{siteConfig.title}

+

{siteConfig.tagline}

Request Access
+
+

What is this?

+

We are non-profit provider of cloud services for select public.

+

+ Our goal is to provide well integrated and coherent suite of + applications
that can rival offers of propriatery and + for-profit companies. +

+

We use and build on top of open source software.

+

+ You can read more about our{" "} + + Architecture + {" "} + and{" "} + + Hardware + {" "} + in the{" "} + + Documentation + + . +

+
); } @@ -36,12 +63,29 @@ function HomepageHeader() { export default function Home(): JSX.Element { const { siteConfig } = useDocusaurusContext(); return ( - +
+
+
+

What is this?

+

+ We are non-profit provider of cloud services for select public. +

+

+ Our goal is to provide well integrated and coherent suite of + applications that can rival offers of propriatery and for-profit + companies. +

+

We use and build on top of open source software.

+

+ You can read more about our{" "} + Architecture and{" "} + Hardware in the{" "} + Documentation. +

+
+
diff --git a/src/pages/markdown-page.md b/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b..0000000 --- a/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/src/pages/request-access.md b/src/pages/request-access.md new file mode 100644 index 0000000..428d53b --- /dev/null +++ b/src/pages/request-access.md @@ -0,0 +1,11 @@ +--- +title: Request Access +--- + +# Reuqest access + +At the moment, we do not yet accept requests. + +In the future we might open registrations for wider public, but each +aplicant would still have to be manually chosen as we do not have the +hardware to support a large number of users.