Skip to content

Commit 1f23d3a

Browse files
author
andrewstech
committed
docs
1 parent 645b0a4 commit 1f23d3a

38 files changed

+16017
-136
lines changed

.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

404.html

-71
This file was deleted.

README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

assets/logo.png

-126 KB
Binary file not shown.

assets/open-domains.net.png

-21 KB
Binary file not shown.

babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

blog/2024-09-02-welcome/index.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
slug: welcome
3+
title: Welcome
4+
authors: [andrewstech]
5+
tags: [open-domains]
6+
---
7+
8+
Welcome to the Open Domains blog! This is the first post on the blog, and I'm excited to share more about the project with you. Open Domains is a project that aims to provide free domain names to anyone who wants one. We believe that everyone should have access to the tools they need to create a website, and we want to make it as easy as possible for people to get started.

blog/authors.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
andrewstech:
2+
name: AndrewsTech
3+
title: Owner of OpenDomains
4+
url: https://github.com/yang
5+
image_url: https://github.com/andrewstech.png
6+
page: true
7+
socials:
8+
x: andrewstech1
9+
github: andrewstech
10+
11+

blog/tags.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
open-domains:
2+
label: Open Domains
3+
permalink: /domains/
4+
description: Open Domains Tag
5+
6+

docs/intro.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Introduction
6+
7+
Welcome to Open Domains! We're excited to have you here. Open Domains is a project that aims to provide free domain names to anyone who wants one. We believe that everyone should have access to the tools they need to create a website, and we want to make it as easy as possible for people to get started.
8+
9+
## How it works
10+
11+
We own a number of domains that we allow people to use for free. You can choose a domain from our list and create a subdomain for your project. For example, if you wanted to create a website for your blog, you could choose the subdomain `blog.is-not-a.dev`.
12+
13+
## Why we're doing this
14+
15+
We believe that everyone should have access to the tools they need to create a website. We know that getting started can be difficult, especially if you're new to web development. By providing free domain names, we hope to make it easier for people to get started and share their projects with the world.
16+
17+
18+
## The PSL
19+
20+
The Public Suffix List (PSL) is a list of domain suffixes that are used by browsers to determine the boundaries of cookies. We use the PSL to ensure that our subdomains are treated as separate entities by browsers. This helps to protect the privacy and security of our users.

docs/tutorial-basics/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Tutorial - Basics",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "5 minutes to learn the most important Docusaurus concepts."
7+
}
8+
}
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Congratulations!
6+
7+
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
8+
9+
Docusaurus has **much more to offer**!
10+
11+
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
12+
13+
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
14+
15+
## What's next?
16+
17+
- Read the [official documentation](https://docusaurus.io/)
18+
- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
19+
- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
20+
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
21+
- Add a [search bar](https://docusaurus.io/docs/search)
22+
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
23+
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Create a Blog Post
6+
7+
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
8+
9+
## Create your first Post
10+
11+
Create a file at `blog/2021-02-28-greetings.md`:
12+
13+
```md title="blog/2021-02-28-greetings.md"
14+
---
15+
slug: greetings
16+
title: Greetings!
17+
authors:
18+
- name: Joel Marcey
19+
title: Co-creator of Docusaurus 1
20+
url: https://github.com/JoelMarcey
21+
image_url: https://github.com/JoelMarcey.png
22+
- name: Sébastien Lorber
23+
title: Docusaurus maintainer
24+
url: https://sebastienlorber.com
25+
image_url: https://github.com/slorber.png
26+
tags: [greetings]
27+
---
28+
29+
Congratulations, you have made your first post!
30+
31+
Feel free to play around and edit this post as much as you like.
32+
```
33+
34+
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Create a Document
6+
7+
Documents are **groups of pages** connected through:
8+
9+
- a **sidebar**
10+
- **previous/next navigation**
11+
- **versioning**
12+
13+
## Create your first Doc
14+
15+
Create a Markdown file at `docs/hello.md`:
16+
17+
```md title="docs/hello.md"
18+
# Hello
19+
20+
This is my **first Docusaurus document**!
21+
```
22+
23+
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
24+
25+
## Configure the Sidebar
26+
27+
Docusaurus automatically **creates a sidebar** from the `docs` folder.
28+
29+
Add metadata to customize the sidebar label and position:
30+
31+
```md title="docs/hello.md" {1-4}
32+
---
33+
sidebar_label: 'Hi!'
34+
sidebar_position: 3
35+
---
36+
37+
# Hello
38+
39+
This is my **first Docusaurus document**!
40+
```
41+
42+
It is also possible to create your sidebar explicitly in `sidebars.js`:
43+
44+
```js title="sidebars.js"
45+
export default {
46+
tutorialSidebar: [
47+
'intro',
48+
// highlight-next-line
49+
'hello',
50+
{
51+
type: 'category',
52+
label: 'Tutorial',
53+
items: ['tutorial-basics/create-a-document'],
54+
},
55+
],
56+
};
57+
```

docs/tutorial-basics/create-a-page.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Create a Page
6+
7+
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
8+
9+
- `src/pages/index.js``localhost:3000/`
10+
- `src/pages/foo.md``localhost:3000/foo`
11+
- `src/pages/foo/bar.js``localhost:3000/foo/bar`
12+
13+
## Create your first React Page
14+
15+
Create a file at `src/pages/my-react-page.js`:
16+
17+
```jsx title="src/pages/my-react-page.js"
18+
import React from 'react';
19+
import Layout from '@theme/Layout';
20+
21+
export default function MyReactPage() {
22+
return (
23+
<Layout>
24+
<h1>My React page</h1>
25+
<p>This is a React page</p>
26+
</Layout>
27+
);
28+
}
29+
```
30+
31+
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
32+
33+
## Create your first Markdown Page
34+
35+
Create a file at `src/pages/my-markdown-page.md`:
36+
37+
```mdx title="src/pages/my-markdown-page.md"
38+
# My Markdown page
39+
40+
This is a Markdown page
41+
```
42+
43+
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Deploy your site
6+
7+
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
8+
9+
It builds your site as simple **static HTML, JavaScript and CSS files**.
10+
11+
## Build your site
12+
13+
Build your site **for production**:
14+
15+
```bash
16+
npm run build
17+
```
18+
19+
The static files are generated in the `build` folder.
20+
21+
## Deploy your site
22+
23+
Test your production build locally:
24+
25+
```bash
26+
npm run serve
27+
```
28+
29+
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
30+
31+
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)**).

0 commit comments

Comments
 (0)