Skip to content

Commit afe6f9b

Browse files
authored
Update README.md
1 parent b46f654 commit afe6f9b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,17 @@ You must also choose a theme:
5757
That's it! Now you can juste use the link provided by Github to access you website:
5858

5959
![](./printscreen4.png)
60+
61+
## Usage guide
62+
63+
* Any markdown file in your repository will display in your Github Pages website. You just have to use the same path to access it and replace the `.md` extension by `.html`.
64+
* To make links between your Markdown files just use a relative path to the other Markdown file. The configuration you copy pasted in your `_config.yml` provides a plugin to convert those URLs. So your Markdown files will have correct links both in Github and Github Pages.
65+
* You should be able to use any [Github Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
66+
67+
## Contributing
68+
69+
See the [Contribution Guide](./CONTRIBUTING.md).
70+
71+
## License
72+
73+
See the [License File](./LICENSE.md).

0 commit comments

Comments
 (0)