commit db6f7fefae70e63e577a88627fd2b4e0505749d9 Author: 3zachm <3zachm2@gmail.com> Date: Thu Feb 9 00:58:01 2023 -0800 init diff --git a/README.md b/README.md new file mode 100644 index 0000000..b6912dc --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# InvestWiki + +The toffee wiki repo! + +## Usage + +Within the `./wiki` directory, each subdir corresponds to an actual path on the website. + +For example, `./wiki/home/[lang].md` gets translated to `/wiki/[lang]/home` when built on the server, where lang is replaced with the browser's language code (or whatever's manually specified). + +### Relative links + +Use the relative directory structure present in the repo. The site will parse the language for you through its middleware. + +If you're currently on the page (directory) `/wiki/bot`: + +`usage` will correspond to `/wiki/bot/usage` (you can also specify `/wiki/bot/usage`) directly if you wish. + +**However, do not end the relative URL with an ending slash** as you'll see in a second. + +### Direct links + +#### Internal + +If you want to link to a specific internal link, end the URL with an ending slash! + +`/ranking/` links to the ranking page on the site +`/wiki/ja/home/` directly links to the Japanese version of home + +#### External + +Just link as you normally would with the `https` prefix. It should not be needed to add the domain to the `next.config.js` as we aren't using its optimizer for markdown images. + +### Images + +#### Internal + +Conventionally, store images you'd like to use in a folder called img within the same subdir and refer to them relatively. + +`img/image_name.webp` + +Using a starting slash will refer to it as a absolute/direct path, so if you need to refer to another image in different page, just prefix the entire path with `/img` + +`/img/wiki/bot/img/image_name.webp` + +#### External + +Same as for links! + +## Contributing + +tbd (?) diff --git a/wiki/home/en.md b/wiki/home/en.md new file mode 100644 index 0000000..c049cb2 --- /dev/null +++ b/wiki/home/en.md @@ -0,0 +1,64 @@ +--- +layout: "home" +--- + +# toffee wiki + +Official WIP wiki!! + +## Pages + +[Example alternative language](/wiki/ja/) + +Eventually there will be other things!!! + +## Markdown Support + +some random examples! + +### Syntax Highlighting + +```jsx +export default function RenderMarkdown({ children }: RenderMarkdownProps) { + return ( + + {children} + + ); +} +``` + +### Images + +![image alt](img/4x.webp "Image title text!") + +### GFM + +#### Autolink literals + +www.example.com, , and contact@example.com. + +#### Footnote + +A note[^1] + +[^1]: Big note. + +#### Strikethrough + +~one~ or ~~two~~ tildes. + +#### Table + +| Syntax | Description | +| --------- | ----------- | +| Header | Title | +| Paragraph | Text | + +#### Tasklist + +- [ ] to do +- [x] done diff --git a/wiki/home/img/4x.webp b/wiki/home/img/4x.webp new file mode 100644 index 0000000..0907051 Binary files /dev/null and b/wiki/home/img/4x.webp differ