+ + + +
+ ++ The front facing website for the Kibisis wallet. +
+ ++ The website is built using Docusaurus and fills the role of landing page, tutorial and blog. +
+ ++ + + +
+ +### Table of contents + +* [1. Overview](#-1-overview) +* [2. Requirements](#-2-requirements) +* [3. Setup](#-3-setup) + * [3.1. Installations](#31-installations) +* [4. Development](#-4-development) + * [4.1. Running locally](#41-running-locally) +* [5. Deployment](#-5-deployment) + * [5.1. Overview](#51-overview) + * [5.2. Requirements](#52-requirements) + * [5.3. Deploy to `gh-pages` branch](#53-deploy-to-gh-pages-branch) +* [6. Miscellaneous](#-6-miscellaneous) + * [6.1. Useful commands](#61-useful-commands) +* [7. How to Contribute](#-7-how-to-contribute) +* [8. License](#-8-license) + +## π 1. Overview + +TBA... + +[Back to top ^][table-of-contents] + +## π 2. Requirements + +* Install [Node v16.14.0][node] +* Install [Yarn v1.22.5+][yarn] + +[Back to top ^][table-of-contents] + +## π¦ 3. Setup + +### 3.1. Installations + +1. Install the Yarn dependencies: +```shell +yarn install +``` + +[Back to top ^][table-of-contents] + +## π οΈ 4. Development + +### 4.1. Running locally + +1. After the dependencies have been installed, simply run: +```shell +yarn start +``` + +2. If the page is not opened automatically, navigate to [http://localhost:3000](http://localhost:3000). + +[Back to top ^][table-of-contents] + +## π 5. Deployment + +### 5.1. Overview + +Although the deployment is handled through the CI (GitHub Actions), it is necessary to outline the steps that are involved in the deployment. + +[Back to top ^][table-of-contents] + +### 5.2. Requirements + +* Install [Node v16.14.0][node] +* Install [Yarn v1.22.5+][yarn] + +[Back to top ^][table-of-contents] + +### 5.3. Deploy to `gh-pages` branch + +[Back to top ^][table-of-contents] + +## π 6. Miscellaneous + +### 6.1. Useful commands + +| Command | Description | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| `yarn build` | builds the static website in the `/build` directory. | +| `yarn serve` | serves the static website from the `/build` directory. | +| `yarn start` | starts a development server that will serve your website and reflect the latest changes on [http://localhost:3000](http://localhost:3000). | + +[Back to top ^][table-of-contents] + +## π 7. How to Contribute + +Please read the [**Contributing Guide**][contribute] to learn about the development process. + +[Back to top ^][table-of-contents] + +## π 8. License + +Please refer to the [LICENSE][license] file. + +[Back to top ^][table-of-contents] + + +[contribute]: ./CONTRIBUTING.md +[license]: ./LICENSE +[node]: https://nodejs.org/en/ +[table-of-contents]: #table-of-contents +[yarn]: https://yarnpkg.com/ diff --git a/assets/logo-64x64.png b/assets/logo-64x64.png new file mode 100644 index 0000000..cd000f6 Binary files /dev/null and b/assets/logo-64x64.png differ diff --git a/babel.config.js b/babel.config.js new file mode 100644 index 0000000..e00595d --- /dev/null +++ b/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + presets: [require.resolve('@docusaurus/core/lib/babel/preset')], +}; diff --git a/blog/2023-10-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2023-10-26-welcome/docusaurus-plushie-banner.jpeg new file mode 100644 index 0000000..11bda09 Binary files /dev/null and b/blog/2023-10-26-welcome/docusaurus-plushie-banner.jpeg differ diff --git a/blog/2023-10-26-welcome/index.mdx b/blog/2023-10-26-welcome/index.mdx new file mode 100644 index 0000000..62a423a --- /dev/null +++ b/blog/2023-10-26-welcome/index.mdx @@ -0,0 +1,25 @@ +--- +slug: welcome +title: Welcome +authors: [kieran] +tags: [algorand, blockchain] +--- + +[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 new file mode 100644 index 0000000..c6b1ffc --- /dev/null +++ b/blog/authors.yml @@ -0,0 +1,5 @@ +kieran: + name: Kieran O'Neill + title: Current Custodian of Agora Labs + url: https://github.com/kieranroneill + image_url: https://github.com/kieranroneill.png diff --git a/commitlint.config.js b/commitlint.config.js new file mode 100644 index 0000000..337d7a2 --- /dev/null +++ b/commitlint.config.js @@ -0,0 +1,21 @@ +module.exports = { + extends: ['@commitlint/config-conventional'], + rules: { + 'type-enum': [ + 2, + 'always', + [ + 'build', + 'chore', + 'ci', + 'docs', + 'feat', + 'fix', + 'perf', + 'refactor', + 'revert', + 'test', + ], + ], + }, +}; diff --git a/docs/intro.md b/docs/intro.md new file mode 100644 index 0000000..8a2e69d --- /dev/null +++ b/docs/intro.md @@ -0,0 +1,47 @@ +--- +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 new file mode 100644 index 0000000..2e6db55 --- /dev/null +++ b/docs/tutorial-basics/_category_.json @@ -0,0 +1,8 @@ +{ + "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 new file mode 100644 index 0000000..04771a0 --- /dev/null +++ b/docs/tutorial-basics/congratulations.md @@ -0,0 +1,23 @@ +--- +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 new file mode 100644 index 0000000..ea472bb --- /dev/null +++ b/docs/tutorial-basics/create-a-blog-post.md @@ -0,0 +1,34 @@ +--- +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 new file mode 100644 index 0000000..ffddfa8 --- /dev/null +++ b/docs/tutorial-basics/create-a-document.md @@ -0,0 +1,57 @@ +--- +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 new file mode 100644 index 0000000..20e2ac3 --- /dev/null +++ b/docs/tutorial-basics/create-a-page.md @@ -0,0 +1,43 @@ +--- +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 ( +This is a React page
+docs
directory.
+ >
+ ),
+ },
+ {
+ title: 'Powered by React',
+ Svg: poweredByReact,
+ description: (
+ <>
+ Extend or customize your website layout by reusing React. Docusaurus can
+ be extended while reusing the same header and footer.
+ >
+ ),
+ },
+];
+
+function Feature({ title, Svg, description }: FeatureItem) {
+ return (
+ {description}
+{siteConfig.tagline}
+