jekyll-theme-consulting icon indicating copy to clipboard operation
jekyll-theme-consulting copied to clipboard

Installation instructions less than complete

Open antgel opened this issue 6 years ago • 1 comments

I created a new Jekyll site with jekyll new and updated Gemfile and _config.yml, however the resulting initial site is almost useless, lacking config and content. Therefore I'm working on a fork of this repository. Is that not a more sensible approach, or have I missed something?

antgel avatar Oct 24 '19 17:10 antgel

Hi Antony,

You're right the readme lacks information on how-to use the theme features.

Forking will work if you intend on completing the configuration instructions in the readme. Contributions are always welcome!

In the meantime, the features do exist. If you want to know how to configure your website, I suggest you copy & edit the following files to suit your needs:

  • _config.yml
  • robots.md to generate the robots.txt
  • sitemap.md to generate the sitemap.xml
  • search.md to generate a search index to support the in-site search engine
  • en/index.md to have an example of a fully configured front matter
  • _data/menus.yml to see how to define the website lateral menus

it's quite straighforward honestly, most of the coding has been abstracted away you just need to fill in the title and whatnot variables.

apehex avatar Nov 14 '19 10:11 apehex