https://github.com/dianavile/rgsocdvteam
Resources, Learnings, Courses, Testing, Meetings- all in one in Markdown.
https://github.com/dianavile/rgsocdvteam
designsystem docs documentation generator livingstyleguide markdown markdown-it parser styleguide
Last synced: about 2 months ago
JSON representation
Resources, Learnings, Courses, Testing, Meetings- all in one in Markdown.
- Host: GitHub
- URL: https://github.com/dianavile/rgsocdvteam
- Owner: dianavile
- License: mit
- Created: 2018-07-04T10:49:10.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-21T17:55:45.000Z (almost 8 years ago)
- Last Synced: 2025-04-09T21:58:09.821Z (about 1 year ago)
- Topics: designsystem, docs, documentation, generator, livingstyleguide, markdown, markdown-it, parser, styleguide
- Language: JavaScript
- Size: 3.37 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README-EXAMPLE.md
- License: LICENSE
Awesome Lists containing this project
README
# README NAME OF PROJECT
- What the project is about? (short project description)
- Why does this project exist? (short motivation)
- What makes your project stand out? (features)
## Getting Started
- Instructions to get copy of the project
- Instructions to run project on local machine (for development and testing)
### Prerequisites
- What is needed to install the software?
- How to install it?
```
Give examples
```
# Code Example
- Show what the library does.
- How does your project solve developers problem (see: code example).
- Show an obvious API
- Make code short and concise.
### Installation
- How to get development environment running?
- step-by-step series of examples (descriptions, how to install, step by step)
Step 1
```
Give the example
```
Repeat
```
until finished
```
End with Example of
- getting some data out of the system
- using data for a little demo
## Screenshots
Include logo/demo screenshot.
## Build status
- What is the build status of continus integration?
## Code style
- Which code styles are used for this project?
- PIMD uses the [StandardJS](https://standardjs.com) style.
## Testing
- Explain how to run the automated tests for this system
### End-to-end-tests
- Explain what these tests test and why
```
Give an example
```
### Coding style tests
- Explain what these tests test and why
```
Give an example
```
## Deployment
Add additional notes about how to deploy this on a live system
How to use?
If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.
## Code Dependencies
This ... is __built with__ the following dependencies (tech/frameworks):
* []() -
* []() -
* []() -
## Contributing
Please read [CONTRIBUTING.md]() for details on our code of conduct, and the process for submitting pull requests to us.
## Authors
- Copyright 2018++ -[NAME](URL).
- Get in touch with [@NAME](URL) on Twitter or [open an issue](URL).
## Contributors
- [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the MIT License. See [MIT-LICENSE](LICENSE.md) for details.
## Acknowledgments
* Hat tip to anyone whose code was used
* Inspiration