https://github.com/vermontdepartmentofhealth/docgov
some public facing standards, guidelines, and, well, documentation
https://github.com/vermontdepartmentofhealth/docgov
Last synced: 2 months ago
JSON representation
some public facing standards, guidelines, and, well, documentation
- Host: GitHub
- URL: https://github.com/vermontdepartmentofhealth/docgov
- Owner: VermontDepartmentOfHealth
- License: mit
- Created: 2019-06-12T21:33:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-20T13:52:36.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T06:57:39.595Z (3 months ago)
- Language: CSS
- Homepage: https://docgov.netlify.app/
- Size: 14.6 MB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
layout: default.njk
title: Read Me
tags: ['page']
toc: true
permalink: 'readme.md/index.html'
---
# [Doc Gov](https://docgov.dev)
A Collection of public facing Overviews, Guidelines, Strategies, Standards, Technologies, and other shareable resources at VDH / AHS / ADS
[](https://app.netlify.com/sites/open-sourced/deploys)
## Powered By
* [**Eleventy**](https://www.11ty.io) - static site generation
* [**Netlify**](https://www.netlify.com/) - static site hosting
* [markdown-it](https://github.com/markdown-it/markdown-it) - markdown processor
## Project Wikis
* [ReadMe](/readme.md) - Running the project locally and overview of project architecture
* [Contributing](/contributing.md) - Guidelines for authoring a post
* [Code of Conduct](/code_of_conduct.md) - Requirements for being a respectful community member
* [Resources](/resources.md) - Scratchpad of links and notes during development
* [Changelog](/changelog.md) - Release notes over time
## Project Setup
1. Install [Node.js & NPM](https://nodejs.org/en/download/)
2. Run `npm install` in the project directory to install local dependencies
3. Install eleventy globally
```bash
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](http://localhost:8080)
## NPM Scripts
```bash
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
``` bash
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
* *``*
* `eleventyExcludeFromCollections` - will still be processed, but won't appear in collections