During the build process, Markdown sources are converted into HTML pages, and their file extensions are changed from *.md
to *.html
. When creating local links, ensure to replace the .md
file extension with .html
.
To maintain website portability, utilize the site.url
and site.baseurl
variables when creating local links. Absolute local links should start with {{ site.url }}{{ site.baseurl }}, while root-relative links should begin with {{ site.baseurl }}:
Correct | Incorrect |
---|---|
[link]({{ site.url }}{{ site.baseurl }}/dir/doc.html) |
[link](https://rspamd.com/dir/doc.html) |
[link]({{ site.baseurl }}/dir/doc.html) |
[link](/dir/doc.html) |
Before submitting a pull request, it’s advisable to verify how your changes affect the website (formatting, links, highlighting, etc.). Fortunately, this can be easily accomplished using GitHub Pages.
To enable GitHub Action workflows:
To configure your site for publishing with GitHub Actions:
Your website will be accessible at https://<user>.github.io/<repository>
.