klc

Documentation for the KiCad Library Convention at https://klc.kicad.org

The klc repository is dual licensed. You may distribute it and/or modify it under the terms of either the GNU General Public License (http://www.gnu.org/licenses/gpl.html), version 3 or later, or the Creative Commons Attribution License (http://creativecommons.org/licenses/by/3.0/), version 3.0 or later.

You will need these packages:

• hugo version 0.77.0 (you must use this version!)

• ruby (to use asciidoctor)

• asciidoctor version 2.0.10

Using asciidoctor is a requirement, because the original asciidoc runs into trouble parsing the adoc files with TOML headers in them. asciidoctor also has a few extra features for web pages.

Execute the hugo command in the repository root to build and serve the files for development:

Observe the console output as it will tell you the address where the page is accessible in a browser. The -w flag tells it to watch the filesystem for changes to rebuild automatically. Also, the page in the browser will autorefresh once the rebuild completes successfully.