diff --git a/documentation/docs/Installation/_category_.json b/documentation/docs/Installation/_category_.json new file mode 100644 index 0000000..fd67cf3 --- /dev/null +++ b/documentation/docs/Installation/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Installation 🖥️", + "position": 2, + "link": { + "type": "generated-index", + "description": "How to get AdventureLog installed and setup." + } +} diff --git a/documentation/docs/tutorial-basics/congratulations.md b/documentation/docs/Installation/congratulations.md similarity index 95% rename from documentation/docs/tutorial-basics/congratulations.md rename to documentation/docs/Installation/congratulations.md index 04771a0..0a69137 100644 --- a/documentation/docs/tutorial-basics/congratulations.md +++ b/documentation/docs/Installation/congratulations.md @@ -1,8 +1,8 @@ --- -sidebar_position: 6 +sidebar_position: 3 --- -# Congratulations! +# Congratulations! 🎉 You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. diff --git a/documentation/docs/Installation/docker.md b/documentation/docs/Installation/docker.md new file mode 100644 index 0000000..28119a5 --- /dev/null +++ b/documentation/docs/Installation/docker.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 1 +--- + +# Docker 🐋 diff --git a/documentation/docs/Installation/local.md b/documentation/docs/Installation/local.md new file mode 100644 index 0000000..47ffd7f --- /dev/null +++ b/documentation/docs/Installation/local.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 2 +--- + +# Local 🖥️ diff --git a/documentation/docs/Usage/_category_.json b/documentation/docs/Usage/_category_.json new file mode 100644 index 0000000..7594506 --- /dev/null +++ b/documentation/docs/Usage/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Usage ✈️", + "position": 3, + "link": { + "type": "generated-index", + "description": "How to use AdventureLog." + } +} diff --git a/documentation/docs/tutorial-extras/img/docsVersionDropdown.png b/documentation/docs/Usage/img/docsVersionDropdown.png similarity index 100% rename from documentation/docs/tutorial-extras/img/docsVersionDropdown.png rename to documentation/docs/Usage/img/docsVersionDropdown.png diff --git a/documentation/docs/tutorial-extras/img/localeDropdown.png b/documentation/docs/Usage/img/localeDropdown.png similarity index 100% rename from documentation/docs/tutorial-extras/img/localeDropdown.png rename to documentation/docs/Usage/img/localeDropdown.png diff --git a/documentation/docs/tutorial-extras/manage-docs-versions.md b/documentation/docs/Usage/manage-docs-versions.md similarity index 100% rename from documentation/docs/tutorial-extras/manage-docs-versions.md rename to documentation/docs/Usage/manage-docs-versions.md diff --git a/documentation/docs/tutorial-extras/translate-your-site.md b/documentation/docs/Usage/translate-your-site.md similarity index 100% rename from documentation/docs/tutorial-extras/translate-your-site.md rename to documentation/docs/Usage/translate-your-site.md diff --git a/documentation/docs/intro.md b/documentation/docs/intro.md index 45e8604..7945a9c 100644 --- a/documentation/docs/intro.md +++ b/documentation/docs/intro.md @@ -2,9 +2,9 @@ sidebar_position: 1 --- -# Tutorial Intro +# Intro 1️⃣ -Let's discover **Docusaurus in less than 5 minutes**. +This tutorial will guide you how to get AdventureLog up and running on your local machine quickly and easily. ## Getting Started diff --git a/documentation/docs/tutorial-basics/_category_.json b/documentation/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55..0000000 --- a/documentation/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/documentation/docs/tutorial-basics/create-a-blog-post.md b/documentation/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 550ae17..0000000 --- a/documentation/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 as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/documentation/docs/tutorial-basics/create-a-document.md b/documentation/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe29..0000000 --- a/documentation/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" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/documentation/docs/tutorial-basics/create-a-page.md b/documentation/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/documentation/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/documentation/docs/tutorial-basics/deploy-your-site.md b/documentation/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/documentation/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/documentation/docs/tutorial-basics/markdown-features.mdx b/documentation/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 35e0082..0000000 --- a/documentation/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,152 +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`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```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: - -```md -:::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/documentation/docs/tutorial-extras/_category_.json b/documentation/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc1..0000000 --- a/documentation/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/documentation/docusaurus.config.ts b/documentation/docusaurus.config.ts index f227127..56184a4 100644 --- a/documentation/docusaurus.config.ts +++ b/documentation/docusaurus.config.ts @@ -92,7 +92,7 @@ const config: Config = { title: "Docs", items: [ { - label: "Tutorial", + label: "Intro", to: "/docs/intro", }, ], diff --git a/documentation/src/components/HomepageFeatures/index.tsx b/documentation/src/components/HomepageFeatures/index.tsx index 50a9e6f..04508d7 100644 --- a/documentation/src/components/HomepageFeatures/index.tsx +++ b/documentation/src/components/HomepageFeatures/index.tsx @@ -1,49 +1,45 @@ -import clsx from 'clsx'; -import Heading from '@theme/Heading'; -import styles from './styles.module.css'; +import clsx from "clsx"; +import Heading from "@theme/Heading"; +import styles from "./styles.module.css"; type FeatureItem = { title: string; - Svg: React.ComponentType>; + Svg: React.ComponentType>; description: JSX.Element; }; const FeatureList: FeatureItem[] = [ { - title: 'Easy to Use', - Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default, + title: "Log Your Travels", + Svg: require("@site/static/img/undraw_explore.svg").default, description: ( <> - Docusaurus was designed from the ground up to be easily installed and - used to get your website up and running quickly. + AdventureLog is a simple way to log your travels and share them with the + world. You can add photos, notes, and more to your logs. ), }, { - title: 'Focus on What Matters', - Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default, + title: "Track Your World Travel", + Svg: require("@site/static/img/undraw_adventure.svg").default, description: ( <> - Docusaurus lets you focus on your docs, and we'll do the chores. Go - ahead and move your docs into the docs directory. + Keep track of the countries you've visited, the regions you've explored, + and the places you've been. You can also see your travel stats and + milestones (coming soon). ), }, { - title: 'Powered by React', - Svg: require('@site/static/img/undraw_docusaurus_react.svg').default, - description: ( - <> - Extend or customize your website layout by reusing React. Docusaurus can - be extended while reusing the same header and footer. - - ), + title: "View a Map of Your Travels", + Svg: require("@site/static/img/undraw_map_dark.svg").default, + description: <>See a map of all the places you've been., }, ]; -function Feature({title, Svg, description}: FeatureItem) { +function Feature({ title, Svg, description }: FeatureItem) { return ( -
+
diff --git a/documentation/static/img/undraw_adventure.svg b/documentation/static/img/undraw_adventure.svg new file mode 100644 index 0000000..6563508 --- /dev/null +++ b/documentation/static/img/undraw_adventure.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/static/img/undraw_explore.svg b/documentation/static/img/undraw_explore.svg new file mode 100644 index 0000000..5fbdb8f --- /dev/null +++ b/documentation/static/img/undraw_explore.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/documentation/static/img/undraw_map_dark.svg b/documentation/static/img/undraw_map_dark.svg new file mode 100644 index 0000000..0d6e5d7 --- /dev/null +++ b/documentation/static/img/undraw_map_dark.svg @@ -0,0 +1 @@ + \ No newline at end of file