www

Snowpack docs

We aim to follow the Diátaxis documentation system though a lot of our docs are legacy and don't necessarily fit it yet.

Architecture

• Markdown files that become pages are in /template
• SASS files in css
• templates in _includes

Style guide

• Terminology
  • Use "Snowpack project" rather than Snowpack app/webapp or Snowpack site in docs
  • Exceptions are in blog posts or introductory material where the other terms are easier to understand
• Sentence-style capitalization
• Oxford comma
• Capitalize after colons
• Avoid using vague terms for link text like "here"

Vale

Vale is a text linter. A selection of rules based on our style guide are available in the Vale directory. Right now Vale usage in this repository is experimental but once we have some experience with using these we plan on integrating them as tests.

Reference documentation formatting

For reference documentation (APIs, configuration, etc.), use the following format:

method/name | `type` |  Default: `value` | _required_ : description

Default is optional and only applies if there is a default. _required_ can be omitted if the value is optional.

Example:

devOptions.open | `string` | Default: `"default"`

If it's a heading use the extended format with the rest of the information below the heading:

#### name
**Type:** `string`

**Default:** `value`

_required_

Short 1-2 sentence description ideally the same as what's in the code comments.

Details

Example(s):

Types

The type notation we use is ???

We could use Swagger https://swagger.io/docs/specification/data-models/data-types/

Or use TypeScript notation though will people understand that?

Code blocks

Code blocks should have a top comment with information about the code: 1st line: required if this a code snippet about a specific file 2nd line: describe the change, not always required but recommended. Start with Example: if relevent. 3rd line: if a dependency is implied, add the npm install script here

Example:

// snowpack.config.js
// Example: Connect the Sass plugin
// [npm install @snowpack/plugin-sass]
module.exports = {
  plugins: [
    ['@snowpack/plugin-sass', { /* see options below */ }
  ],
};