52 lines
3.1 KiB
Markdown
52 lines
3.1 KiB
Markdown
+++
|
|
title = "Library setup"
|
|
tags = ["example tag", "quickstart"]
|
|
+++
|
|
|
|
By now, you should have followed the {{% pattern "Installation" %}} instructions. You should have Hugo and Node installed, and a local copy of a forked version of **Infusion**. You should also have run `npm install` in the root of that codebase.
|
|
|
|
## "Cleaning" the content folder
|
|
|
|
Before you can start documenting patterns, there are a few things still to do in order to get set up. At the moment, your version of **Infusion** is a facsimile of the original, containing all this documentation content. We want to delete that content and replace it with some starter content. There's a simple `clean` command for this.
|
|
|
|
{{% warning %}}
|
|
If you are contributing to an existing **Infusion** library, do not run the following command. It will delete all of the patterns in that library. The `clean` command is just for libraries that you are starting from scratch.
|
|
{{% /warning %}}
|
|
|
|
{{<cmd>}}npm run clean{{</cmd>}}
|
|
|
|
This will leave your `content` folder with just an `_index.md` file and a `patterns` folder containing a single demonstration pattern file. Find out more about these in {{% pattern "Library structure" %}}.
|
|
|
|
## The `setup` command
|
|
|
|
There's another command, `setup`, which you need to run to create an initial build and make sure git is aware of the `/docs` folder it generates.
|
|
|
|
{{<cmd>}}npm run setup{{</cmd>}}
|
|
|
|
## The config file
|
|
|
|
You'll also want to name your library and configure one or two other things in the `config.toml` file that's found at the root of your project. Here's how that file looks:
|
|
|
|
{{<codeBlock lang="html" numbered="true">}}
|
|
languageCode = "en-us"
|
|
title = "Infusion"
|
|
baseURL = "https://heydon.github.io/infusion/"
|
|
theme = "infusion"
|
|
|
|
[params]
|
|
description = "Documentation for the <strong>Inclusive Pattern Docs</strong> pattern library builder. This documentation is constructed using the builder itself."
|
|
codePenUser = "Heydon"
|
|
{{</codeBlock>}}
|
|
|
|
* **title** — This is the library's name, like "Megacorp 5000 Pattern Library". You don't have to include the term "pattern library" if you don't want to. For **Infusion's** own version of **Infusion**, the `title` is, naturally, _Infusion_ :-)
|
|
* **baseURL** — This is the root of the live site. Typically you will publish the site to Github Pages, so this should be the base URL for your Github Pages site.
|
|
* **theme** — This is the theme the library is using. Don't change this from "infusion".
|
|
* **description** — This is a short description of the library and comes under the logo. You can include HTML like `<em>` and `<strong>`.
|
|
* **codePenUser** — If you want to embed codePens in your pattern files, you need to supply a codePen username here.
|
|
|
|
## Including a logo
|
|
|
|
In the `static` folder, you'll find a `logo.png` file. Replace this file with your own company or project logo. Currently, only the PNG format is supported.
|
|
|
|
Now that your logo's in place, everything should be ready. Where next? You can learn about {{% pattern "Library structure" %}} to help you get writing, or find out how to serve the library locally and on Github Pages in {{% pattern "Serving" %}}.
|