Welcome to the OI Lume Template. You can see what this looks like by visiting https://open-innovations.github.io/oi-lume-template/.
You'll need to customise some things to get started:
- Review the contents of
_config.ts. Pay particular attention to the site URL, as this will affect how relative links are created. You can probably ignore the rest of this for the moment. - The source for the site is held in the
srcdirectory. - Review the contents of
src/_data.yml- This is where the default page layout is defined in the
layoutkey. The default istemplates/page.njk. This template can be found in the_includesdirectory. - Select colours for the site header and logo by updating the
logo_colourandheader_classkeys. The Open Innovations Brand page will help. - Edit the site title and other SEO metadata in under the
metaskey. See the Lume metas plugin documentation for more information.
- This is where the default page layout is defined in the
- Edit the title of this page in the frontmatter above. You can override the
template by setting the
layoutkey. - Remove all this stuff from this
READMEand write your own!
Either
create a new repoistory from a template
or use the degit tool.
npx degit https://github.com/open-innovations/oi-lume-template/ my-local-pathThe latter is more flexible, as it allows you to insert the template into an existing repository, but comes at the cost of having to have npx installed on your system, which in turn needs node and npm.
I'd recomment the LTS (Long Term Support) version of node if you have to make a choice!.