Focus on content, not the site design and configuration.
No need to write
GitHub Pages will just use
README.md as index page.
In repository settings, enable GitHub Pages for the
For a project site, a
README.md is sufficient.
This also makes updating project site easier.
README.md without the hassles of sync documentation between
For a personal site of articles and notes, just directly write the markdown files. For example:
README.md contact.md python/ persistence.md vim/ completion.md
URLs will be:
/index.html /contact.html /python/persistence.html /vim/completion.html
And GitHub Pages will automatically add a link to
index.html at the header
of every page (except for
and an edit link (fork and request pull within browser)
to the source markdown file in the repository.
In fact, this site is built in a similarly approach. I did wrote three lines of configuration, though.
# _config.yml plugins: # 301 redirects - jekyll-redirect-from # Sitemap for search engines. - jekyll-sitemap # Turn `/contact.html` to `/contact/`. permalink: /:title/
Besides, I also put favicon.ico and 404.html in the repository, to customize favicon and 404 page.