Skip to content

Latest commit

 

History

History
246 lines (174 loc) · 7.38 KB

guide.md

File metadata and controls

246 lines (174 loc) · 7.38 KB
Raw
presentation
progress
true

SAFETAG Toolkit

Getting Started Guide

About this presentation

This presentation is both a markdown guide and an online presentation and we welcome contributions!

You can also find a video version of this presentation.

Topics

Why?

  • Utility - Iterative / Organisation Centric / Streamlined
  • Contribution - "Alive" / Low barriers
  • Context - Minimum Viable Audit / Reporting / Audit Agreement

Toolkit

  • Features: navigate, edit, organise, (soon) contribute
  • Prototype: command line tool, text editor, browser preview.
  • Next? You tell us.

Demo

Concepts

  • Lightweight:
    • Use text for everything
    • Keep history
    • Not a CMS.
  • Content as code:
    • Markdown, Git, Local Static Generation
    • Separate content from code.
    • Transclusion

Install

Prerequisites:

  • node v6
  • npm v5.3.0
    • npm i -g npm
  • docsmith v0.5.3:
    • npm i -g docsmith

safetag init

Use safetag init only on first use.

  • Change your current directory to where you'd like your workspace to be
  • You'll have to confirm the default options.
  • This will setup a ~/.content folder where content packages will be installed.
  • The workspace will link to this folder.

Launch

  • Use safetag start to start a work session

safetag start

  • Open your browser to the local address specified (http://localhost:8081)
  • Start editing content in the workspace

Edit

  • Bring your own favorite editor.
  • Press the down arrow key for some tips.

Atom

  • v1.18.0
  • markdown-preview-enhanced
  • language-markdown

Syntax

Refer to a Markdown manual for the basics of the syntax.

There is some special syntax.

Transclusion

Transclusion is a way to reference content snippets (or more) into a document.

  • index.md
Hi :[](name)!
  • name.md
Alice

Will be rendered as:

Hi Alice!

Organise

  • Edit @safetag/toolkit/browse/categories
  • (for now) Edit ~/.content/packages/safetag-toolkit/toolkit-start.yml
    • metalsmith-lunr
    • metalsmith-search-meta

Contribute

  • Clone
    • https://github.com/contentascode/safetag-toolkit
  • Backup default package
    • mv ~/.content/packages/safetag-toolkit ~/.content/packages/safetag-toolkit.bak
  • Link cloned package
    • ln -s ~/dev/safetag/@safetag/safetag-toolkit ~/.content/packages/safetag-toolkit

Publish

  • git commit and git push
  • npm version patch
  • npm publish

Next