---
# System prepended metadata

title: No Frills Documentation with HackMD
tags: [No Frills Documentation]

---

---
tags: No Frills Documentation
---

# No Frills Documentation with HackMD

[![hackmd-github-sync-badge](https://hackmd.io/-RU7VBbmRfuXShsVXluyDg/badge)](https://hackmd.io/-RU7VBbmRfuXShsVXluyDg)

[toc]

## Problem
How to create content in GitHub with little to no GitHub skills required?

## Solution
Use HackMD to create content, organize it with the Book feature and then save everything in GitHub.

## Prerequisites
Someone in the organization will need basic GitHub skills to:
1. Set up a GitHub a private or public Repository
2. Grant permissions to contributors
3. And/or Merge Pull Requests
4. Explain the HackMD GitHub Sync's "Push" & "Pull" features (That's the only "Github" contributors need to understand)

## Setup Guide
### GitHub
1. Create a public or private repository

### HackMD
1. Consult [HackMD Pricing Types](https://hackmd.io/c/tutorials/%2F%40docs%2Fcreate-and-manage-team#Team-privacy-types) to determine your public vs private needs. It's possible to start with three Team Members for free. You can always upgrade to the paid plan when need be.
1. [How to apply for non-profit sponsorship? - HackMD](https://hackmd.io/c/tutorials/%2F%40docs%2FNPOplan)
1. Consult [What is Team? - HackMD](https://hackmd.io/c/tutorials/%2F%40docs%2Fwhat-is-team)
1. Create your first document. For example: [Hello Documentation World](/aZEZPCAtTdKJOrOR9sQdPw)
1. Optionally organize your Notes with [Tags](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-tag-notes)
1. [How to sync with GitHub - HackMD](https://hackmd.io/c/tutorials/%2Fs%2Flink-with-github)
   - Note: If you choose to add the GitHub Badge, the image file will be broken for private repositories. The link will still open the file in HackMd. See Issue [#247](https://github.com/hackmdio/hackmd-io-issues/issues/247)
3. [How to create a book - HackMD](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-create-book) and create No Frill Book
4. Add your [Hello Documentation World](/aZEZPCAtTdKJOrOR9sQdPw) to the Book
5. Read about [Publishing a Note](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-publish-note#Publishing-a-Note) will 
    > Published notes can be indexed by search engines, and **everyone on the web would be able to find and read them**.