-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2a143fd
commit 673a6ee
Showing
39 changed files
with
10,530 additions
and
7,492 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,20 @@ | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
# Dependencies | ||
/node_modules | ||
/.pnp | ||
.pnp.js | ||
|
||
# testing | ||
/coverage | ||
|
||
# next.js | ||
/.next/ | ||
/out/ | ||
|
||
# production | ||
# Production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
*.pem | ||
|
||
# debug | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# local env files | ||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
# vercel | ||
.vercel | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,33 @@ | ||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
# Website | ||
|
||
## Getting Started | ||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. | ||
|
||
First, run the development server: | ||
## Installation | ||
|
||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
```console | ||
yarn install | ||
``` | ||
|
||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
## Local Development | ||
|
||
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. | ||
|
||
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`. | ||
|
||
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. | ||
```console | ||
yarn start | ||
``` | ||
|
||
## Learn More | ||
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
To learn more about Next.js, take a look at the following resources: | ||
## Build | ||
|
||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
```console | ||
yarn build | ||
``` | ||
|
||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
## Deploy on Vercel | ||
## Deployment | ||
|
||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
```console | ||
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy | ||
``` | ||
|
||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = { | ||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
slug: hola | ||
title: Hola | ||
author: Gao Wei | ||
author_title: Docusaurus Core Team | ||
author_url: https://github.com/wgao19 | ||
author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4 | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
slug: hello-world | ||
title: Hello | ||
author: Endilie Yacop Sucipto | ||
author_title: Maintainer of Docusaurus | ||
author_url: https://github.com/endiliey | ||
author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4 | ||
tags: [hello, docusaurus] | ||
--- | ||
|
||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/). | ||
|
||
<!--truncate--> | ||
|
||
This is a test post. | ||
|
||
A whole bunch of other information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
slug: welcome | ||
title: Welcome | ||
author: Yangshun Tay | ||
author_title: Front End Engineer @ Facebook | ||
author_url: https://github.com/yangshun | ||
author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4 | ||
tags: [facebook, hello, docusaurus] | ||
--- | ||
|
||
Blog features are powered by the blog plugin. Simply add files to the `blog` directory. It supports tags as well! | ||
|
||
Delete the whole directory if you don't want the blog features. As simple as that! |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
--- | ||
id: doc1 | ||
title: Style Guide | ||
sidebar_label: Style Guide | ||
slug: / | ||
--- | ||
|
||
You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/). | ||
|
||
## Markdown Syntax | ||
|
||
To serve as an example page when styling markdown based Docusaurus sites. | ||
|
||
## Headers | ||
|
||
# H1 - Create the best documentation | ||
|
||
## H2 - Create the best documentation | ||
|
||
### H3 - Create the best documentation | ||
|
||
#### H4 - Create the best documentation | ||
|
||
##### H5 - Create the best documentation | ||
|
||
###### H6 - Create the best documentation | ||
|
||
--- | ||
|
||
## Emphasis | ||
|
||
Emphasis, aka italics, with *asterisks* or _underscores_. | ||
|
||
Strong emphasis, aka bold, with **asterisks** or __underscores__. | ||
|
||
Combined emphasis with **asterisks and _underscores_**. | ||
|
||
Strikethrough uses two tildes. ~~Scratch this.~~ | ||
|
||
--- | ||
|
||
## Lists | ||
|
||
1. First ordered list item | ||
1. Another item | ||
- Unordered sub-list. | ||
1. Actual numbers don't matter, just that it's a number | ||
1. Ordered sub-list | ||
1. And another item. | ||
|
||
* Unordered list can use asterisks | ||
|
||
- Or minuses | ||
|
||
+ Or pluses | ||
|
||
--- | ||
|
||
## Links | ||
|
||
[I'm an inline-style link](https://www.google.com/) | ||
|
||
[I'm an inline-style link with title](https://www.google.com/ "Google's Homepage") | ||
|
||
[I'm a reference-style link][arbitrary case-insensitive reference text] | ||
|
||
[You can use numbers for reference-style link definitions][1] | ||
|
||
Or leave it empty and use the [link text itself]. | ||
|
||
URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or <http://www.example.com/> and sometimes example.com (but not on GitHub, for example). | ||
|
||
Some text to show that the reference links can follow later. | ||
|
||
[arbitrary case-insensitive reference text]: https://www.mozilla.org/ | ||
[1]: http://slashdot.org/ | ||
[link text itself]: http://www.reddit.com/ | ||
|
||
--- | ||
|
||
## Images | ||
|
||
Here's our logo (hover to see the title text): | ||
|
||
Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1') | ||
|
||
Reference-style: ![alt text][logo] | ||
|
||
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2' | ||
|
||
Images from any folder can be used by providing path to file. Path should be relative to markdown file. | ||
|
||
![img](../static/img/logo.svg) | ||
|
||
--- | ||
|
||
## Code | ||
|
||
```javascript | ||
var s = 'JavaScript syntax highlighting'; | ||
alert(s); | ||
``` | ||
|
||
```python | ||
s = "Python syntax highlighting" | ||
print(s) | ||
``` | ||
|
||
``` | ||
No language indicated, so no syntax highlighting. | ||
But let's throw in a <b>tag</b>. | ||
``` | ||
|
||
```js {2} | ||
function highlightMe() { | ||
console.log('This line can be highlighted!'); | ||
} | ||
``` | ||
|
||
--- | ||
|
||
## Tables | ||
|
||
Colons can be used to align columns. | ||
|
||
| Tables | Are | Cool | | ||
| ------------- | :-----------: | -----: | | ||
| col 3 is | right-aligned | \$1600 | | ||
| col 2 is | centered | \$12 | | ||
| zebra stripes | are neat | \$1 | | ||
|
||
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. | ||
|
||
| Markdown | Less | Pretty | | ||
| -------- | --------- | ---------- | | ||
| _Still_ | `renders` | **nicely** | | ||
| 1 | 2 | 3 | | ||
|
||
--- | ||
|
||
## Blockquotes | ||
|
||
> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote. | ||
Quote break. | ||
|
||
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote. | ||
--- | ||
|
||
## Inline HTML | ||
|
||
<dl> | ||
<dt>Definition list</dt> | ||
<dd>Is something people use sometimes.</dd> | ||
|
||
<dt>Markdown in HTML</dt> | ||
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd> | ||
</dl> | ||
|
||
--- | ||
|
||
## Line Breaks | ||
|
||
Here's a line for us to start with. | ||
|
||
This line is separated from the one above by two newlines, so it will be a _separate paragraph_. | ||
|
||
This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_. | ||
|
||
--- | ||
|
||
## Admonitions | ||
|
||
:::note | ||
|
||
This is a note | ||
|
||
::: | ||
|
||
:::tip | ||
|
||
This is a tip | ||
|
||
::: | ||
|
||
:::important | ||
|
||
This is important | ||
|
||
::: | ||
|
||
:::caution | ||
|
||
This is a caution | ||
|
||
::: | ||
|
||
:::warning | ||
|
||
This is a warning | ||
|
||
::: |
Oops, something went wrong.