layout: default.njk title: Read Me tags: ['page'] toc: true permalink: 'readme.md/index.html'

Doc Gov

A Collection of public facing Overviews, Guidelines, Strategies, Standards, Technologies, and other shareable resources at VDH / AHS / ADS

Powered By

• Eleventy - static site generation
• Netlify - static site hosting
• markdown-it - markdown processor

Project Wikis

• ReadMe - Running the project locally and overview of project architecture
• Contributing - Guidelines for authoring a post
• Code of Conduct - Requirements for being a respectful community member
• Resources - Scratchpad of links and notes during development
• Changelog - Release notes over time

Project Setup

1. Install Node.js & NPM

2. Run npm install in the project directory to install local dependencies

3. Install eleventy globally

   npm i @11ty/eleventy -g
   npm i rimraf -g
   npm i cross-env -g

4. Run npm run serve to run a local dev environment

5. Access dev copy of the site at localhost:8080

NPM Scripts

npm run build       # builds site for production
npm run serve       # builds site + serves `_site` directory
npm run clean       # deletes `_site` directory
npm run clear-cache # deletes twitter cache
npm run favicon     # generates favicon assets from svg

File Structure

docs
├── _site/                # generated site output
├── .vscode/              # vs code editor configs
├── .github/              # github configs
├── .netlify/             # netlify dev settings
├── node_modules/         # created by npm install
├── admin/                # pages for Netlify CMS
├── assets                # templates and static pass through assets
│   ├── _partials/        # reusable view components
│   ├── images/           # template directory for 11ty
│   │   ├── authors/      # author profile pictures
│   │   ├── icons/        # site wide icons
│   │   ├── posts/        # subfolders for images in each post
│   │   └── uploads/      # generated images for netlify CMS
│   ├── posts/            # subfolders for assets in each post
│   ├── scripts/          # scripts
│   └── styles            # styles
├── data/                 # global data
├── layout/               # layout pages
├── pages/                # durable content structure
├── posts/                # time dated content posts
├── plugins/              # utilities used at runtime
├── tools/                # utilities used at dev time
├── tweets/               # cached tweet data
├── .eleventy.js          # config information for 11ty
├── .eleventyignore       # files won't be watched for re-serving site
├── .env                  # twitter credentials
├── .gitignore            # ignored files in git
├── netlify.toml          # deploy settings for netlify
├── package.json          # lists npm modules, package, and scripts
├── resources.md          # helpful links
└── readme.md             # 🟊 [You Are Here]

Project Architecture

Eleventy Collections

Collections provide a way to enumerate processed content. Collection categories are set by the tags page or added via the .eleventy.js config

• all
  • post (tagged post)
  • published
  • drafts
  • page (tagged page)
  • authors
  • projects
  • departments
  • teams
  • meta
• <tag_names>
• eleventyExcludeFromCollections - will still be processed, but won't appear in collections