Gramps to Markdown

This tool allows to generate Markdown files for all individuals present in a Gramps family tree. These files can later be integrated into a website using any Markdown-compatible static site generator, such as Gatsby or Jekyll.

Prerequisites

• Node.js version 16 or later
• A Gramps XML file (with a .gramps file extension) exported from Gramps

Installation

npm install -g gramps-to-markdown

Usage

gramps2md inputFilePath [output directory] [options]

Examples:

gramps2md genealogy.gramps
gramps2md genealogy.gramps output
gramps2md genealogy.gramps output '{ "languages": ["en", "fr"] }'

Available options

Options are provided as a JSON object (e.g. '{ "languages": ["en", "fr"] }'). The following options are available:

This is an extra usage example using all available options:

gramps2md genealogy.gramps myWebsite/genealogy '{ "urlPrefix": "/genealogy/", "urlExt": ".html", "languages": ["en", "fr"], "includePrivateData": true, "addFrontmatter": true, "extraFrontmatterFields": {"siteSection": "genealogy"} }'

Output Example

This is an example of a Markdown file generated by this tool:

# **Brault, Alexis**

## Other Names

* **Breau, Alexis**

## Life Events  

* 🎂 Birth: **1721-09-22** in **Grand-Pré (Acadie), Kings County, Nouvelle-Écosse, Canada**  
* 🪦 Death: **1811-07-16** in **L'Acadie, Saint-Jean-Sur-Richelieu, MRC du Haut-Richelieu, Montérégie, Québec, Canada**  

## Parents

* 👨 Father: [**Brault, François**](I0362.md)  
* 👩 Mother: [**Comeau, Marie**](I0363.md)  

## Families

### With [**Barillot, Marguerite**](I0355.md)

#### Family Events

* 💒 Marriage: **about** **1750** in **Grand-Pré (Acadie), Kings County, Nouvelle-Écosse, Canada**

#### Children

* [**Brault, Charles**](I0290.md)

## Sources

* *Find A Grave - Millions of Cemetery Records*, [http://www.findagrave.com](http://www.findagrave.com)
  * [https://www.findagrave.com/memorial/122154467/alexis-brault](https://www.findagrave.com/memorial/122154467/alexis-brault)
* *WikiTree*, [http://www.wikitree.com/](http://www.wikitree.com/)
  * [https://www.wikitree.com/wiki/Breau-280](https://www.wikitree.com/wiki/Breau-280)

Such a file is generated for each person in the provided Gramps file. An individuals.md file containing a list of all individuals with links to their files is also generated.

An example of a website integration is available here.

License

Copyright © 2022 Pier-Luc Brault [email protected]

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.