Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a "toDocs" method to Grammar Programs, to automatically generate markdown docs from Grammar files #26

Closed
breck7 opened this issue Jul 27, 2019 · 4 comments
Labels
help wanted good first issue!

Comments

@breck7
Copy link
Owner

breck7 commented Jul 27, 2019

No description provided.

@breck7 breck7 added the help wanted good first issue! label Jul 27, 2019
@breck7
Copy link
Owner Author

breck7 commented Jul 27, 2019

from discussion with ahmed

@breck7
Copy link
Owner Author

breck7 commented Jul 27, 2019

Other ideas for a name: toReadMe()/toTutorial()

@breck7
Copy link
Owner Author

breck7 commented Jul 31, 2019

Here is some pseudocode for the template:

# Documentation for {grammarName}

{grammarName} is a Tree Language for {description}. {grammarName} is built by {authors}, was first started in {year}, and the project homepage is {website}.

This document is for {grammarName} version {versionNumber} and was auto-generated using the [JTree library](linkToJtree) from the Grammar file for {grammarName} found {linkToGrammar}.

## Fun facts

{grammarName} has:
- {cellTypes.length} cell Types
- {nodeTypes.length} nodeTypes.
- The entire source code for this language is {nLines} lines long.

## Quick Example

{rootExample}

## Full Grammar in Tree Format

{dumpGrammarAsFamilyTree}

## NodeType Dictionary

{nodeType defs as table}

## CellType Dictionary

{cellType defs as table}

## Sample program analyzed as spreadsheet

{add this method}

breck7 added a commit that referenced this issue Aug 17, 2019
@breck7
Copy link
Owner Author

breck7 commented Aug 17, 2019

Basic version added

@breck7 breck7 closed this as completed Aug 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted good first issue!
Projects
None yet
Development

No branches or pull requests

1 participant