-
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39 from Vinyl-Davyl/playground-docs-improvement
chore(main): enhanced and updated primary playground documentation
- Loading branch information
Showing
1 changed file
with
98 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,103 @@ | ||
| # Template Playground | ||
| <h1 align="center">Accord Project Template Playground</h1> | ||
| <p align="center"> | ||
| <a href="https://github.com/accordproject/models/blob/master/LICENSE"><img src="https://img.shields.io/github/license/accordproject/models" alt="GitHub license"></a> | ||
| <a href="https://www.accordproject.org/"> | ||
| <img src="https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg" alt="Accord Project" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| A web playground for Accord Project templates: | ||
| This repository hosts the Accord Project Template-Playground. Templates are resourced using the [Template-Engine](https://github.com/accordproject/template-engine), rich-text templates are defined in TemplateMark (either as markdown files, or JSON documents) and are then merged with JSON data to produce output documents. | ||
|
|
||
| 1. TemplateMark for the natural language text | ||
| 2. Concerto for the data model | ||
| 3. TypeScript for logic within the templates | ||
| 4. Markdown-transform to transform the output to HTML, PDF etc. | ||
| ## Accord Project Playground | ||
|
|
||
| **Project Overview** | ||
|
|
||
| The Accord Project Template-Playground is a web-based platform designed to empower developers of all backgrounds to learn and experiment with Accord Project functionalities in a user-friendly and interactive environment. It is a Web playground for Accord Project templates: | ||
|
|
||
| 1. TemplateMark for the natural language text. | ||
| 2. [Concerto](https://docs.accordproject.org/docs/model-concerto.html) for the data model. | ||
| 3. TypeScript for logic within the templates. | ||
| 4. [Markdown-Transform](https://github.com/accordproject/markdown-transform) to transform the output to HTML, PDF etc. | ||
| 5. [Template-Engine](https://github.com/accordproject/template-engine) to convert TemplateMark + JSON data to AgreementMark. | ||
| This playground aims to bridge the gap between static documentation and active learning by providing: | ||
|
|
||
| **Interactive Template Samples** Users can directly edit and test template samples and see the corresponding output in a live preview environment, fostering a hands-on learning experience. | ||
|
|
||
| **Interactive Features:** | ||
|
|
||
| - Live template testing and editing with syntax highlighting and error checking. | ||
| - Real-time preview of code execution results. | ||
|
|
||
| **Getting Involved** | ||
|
|
||
| The Accord Project Playground is an open-source project, welcoming contributions from the developer community. Here are some ways to participate: | ||
|
|
||
| - **Feature Implementation:** Help build core functionalities like interactive code editing, live preview, and integrated learning resources. | ||
| - **Learning Module Development:** Create interactive modules to showcase specific Accord Project functionalities. | ||
| - **Functionality Enhancements:** Improve existing features based on user feedback and project needs. | ||
| - **Documentation and Tutorials:** Contribute to comprehensive documentation and tutorials that guide users through the platform effectively. | ||
|
|
||
| ## Demo | ||
|
|
||
| This code is deployed at: [https://playground.accordproject.org](https://playground.accordproject.org) | ||
| The Template Playground is deployed at: [https://playground.accordproject.org](https://playground.accordproject.org) | ||
|
|
||
| --- | ||
|
|
||
| <p align="center"> | ||
| <a href="https://www.accordproject.org/"> | ||
| <img src="public/APLogo.png" alt="Accord Project Logo" width="400" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="./LICENSE"> | ||
| <img src="https://img.shields.io/github/license/accordproject/cicero?color=bright-green" alt="GitHub license"> | ||
| </a> | ||
| <a href="https://discord.gg/Zm99SKhhtA"> | ||
| <img src="https://img.shields.io/badge/Accord%20Project-Join%20Discord-blue" alt="Join the Accord Project Discord"/> | ||
| </a> | ||
| </p> | ||
|
|
||
| Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the [Linux Foundation][linuxfound]. The technical charter for the Accord Project can be found [here][charter]. | ||
|
|
||
| ## Learn More About Accord Project | ||
|
|
||
| ### [Overview][apmain] | ||
|
|
||
| ### [Documentation][apdoc] | ||
|
|
||
| ## Contributing | ||
|
|
||
| The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code. | ||
|
|
||
| Find out what’s coming on our [blog][apblog]. | ||
|
|
||
| Join the Accord Project Technology Working Group [Discord channel][apdiscord] to get involved! | ||
|
|
||
| For code contributions, read our [CONTRIBUTING guide][contributing] and information for [DEVELOPERS][developers]. | ||
|
|
||
| ### README Badge | ||
|
|
||
| Using Accord Project? Add a README badge to let everyone know: [](https://www.accordproject.org/) | ||
|
|
||
| ``` | ||
| [](https://www.accordproject.org/) | ||
| ``` | ||
|
|
||
| ## License <a name="license"></a> | ||
|
|
||
| Accord Project source code files are made available under the [Apache License, Version 2.0][apache]. | ||
| Accord Project documentation files are made available under the [Creative Commons Attribution 4.0 International License][creativecommons] (CC-BY-4.0). | ||
|
|
||
| Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See [LF Projects Trademark Policy](https://lfprojects.org/policies/trademark-policy/). | ||
|
|
||
| [linuxfound]: https://www.linuxfoundation.org | ||
| [charter]: https://github.com/accordproject/governance/blob/master/accord-project-technical-charter.md | ||
| [apmain]: https://accordproject.org/ | ||
| [apblog]: https://accordproject.org/news | ||
| [apdoc]: https://docs.accordproject.org/ | ||
| [apdiscord]: https://discord.gg/Zm99SKhhtA | ||
| [contributing]: https://github.com/accordproject/models/blob/master/CONTRIBUTING.md | ||
| [developers]: https://github.com/accordproject/models/blob/master/DEVELOPERS.md | ||
| [apache]: https://github.com/accordproject/models/blob/master/LICENSE | ||
| [creativecommons]: http://creativecommons.org/licenses/by/4.0/ |