Liquid docs is a starter project based on 11ty and Stencil and acts as the foundation for the Liquid Oxygen documentation.
- Clone this repository:
git clone git@github.com:emdgroup-liquid/liquid-docs.git- Install dependencies:
npm install- Start up the development server:
npm start- Edit markdown pages in
src/docs/pages. Make sure to supply front matter data at the top of your markdown file. Here is an example:
---
eleventyNavigation:
key: Getting started
parent: Introduction
order: 1
layout: layout.njk
title: Getting started
permalink: introduction/getting-started/
tags:
- installation
- setup
---- Modify the functionality of the docs:
- by editing existing or adding new components inside the folder
src/docs/components. For instance, if you want to change the logo and the heading in the page header or if you want to replace / remove the GitHub button, head over tosrc/docs/components/docs-topbar.tsxand change it according to your requirements. - by configuring existing or adding new 11ty plugins, shortcodes, filters etc. in
.eleventy.js.
- Deploy the
dist-docsdirectory to the hosting environment of your choice.
If you'd like to contribute to the project, please read our code of conduct. Then proceed to the contributing docs.
This project is available under a custom license which restricts its usage to applications created for or by Merck KGaA, Darmstadt, Germany as well as its vendors.