Glossary

Glossary of terms used within the MAPS project and the Micronutrient Support Tool
Explore the docs »

View Rendered Glossary · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Definitions of commonly used terms within the within the MAPS project and the Micronutrient Support Tool are stored in markdown files within the /terms directory.

These are rendered into the interactive glossary webpage hosted at https://glossary.micronutrient.support.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 11ty
• Spectre.css
• GitHub Pages

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• node.js - follow instructions at https://nodejs.org/en/

Installation

2. Clone the repo

git clone https://github.com/micronutrientsupport/glossary.git

3. Install NPM packages

npm install

4. Build site

npm run build

5. View rendered glossary

http://localhost:3000

Usage

At a minimum, all markdown files must have a title and short description in the yaml front-matter.

Extended content can be included as markdown which can include images etc and are converted into an individual webpage. e.g. https://raw.githubusercontent.com/micronutrientsupport/glossary/master/terms/uon.md

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b terms/NewTerms)
3. Commit your Changes (git commit -m 'Add some new terms')
4. Push to the Branch (git push origin terms/NewTerms)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Andy Bean - @mnd_support - [email protected]

Project Link: https://github.com/micronutrientsupport/glossary

Acknowledgements

• Initial terms list - Kevin Tang