Skip to content

Commit 318ad76

Browse files
authored
Update README.md
1 parent 1cf6171 commit 318ad76

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,16 @@ To set up a project page, we support [MDX](https://mdxjs.com/), which is a super
3535
**Step**
3636
1. Create a folder of your project under `app/projects`.
3737
2. Create a `page.mdx` file under the created folder. This is the main file that contains your page content. Assets (e.g. images) should be uploaded to your project folder as well.
38-
3. Update the `page`key of your publication in `config/publications.ts` with the name of your folder.
38+
3. Update the `page` key of your publication in `config/publications.ts` with the name of your folder.
3939

4040

41-
Find an example in `app/projects/mage`.
41+
Find an example in `app/projects/mage`.
42+
43+
### GGLab-flavored Markdown
44+
We extend the markdown syntax to better styling our website. Here are some special usages,
45+
#### Scaling images
46+
Add the `scale=x` option after your title, separated by `|`.
47+
```
48+
![title|scale=0.5](./path/to/your/image)
49+
```
50+

0 commit comments

Comments
 (0)