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

Tutorial doc fixes #13

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

FloatingFront
Copy link

Started the tutorial doc fixes.

benwilson512 and others added 5 commits November 16, 2017 07:32
to make it easier for newcomers to find their feet without
tripping up.
https://github.com/absinthe-graphql/absinthe/tree/master/guides/tutorial

to

https://github.com/absinthe-graphql/absinthe_tutorial

with the following change suggestions

added /src subdirectory to the /tutorial directory
put the *.md files into this /src subdirectory

created two scripts (either one will do - you choose which one you like better) ,
- convert-md-to-html.sh generates the *.html files into the parent directory
- make-html-from-md.sh generates the *.md.html files into the parent directory

(the difference is in the naming of the resulting html files : *.html vs. *.md.html naming)

The resulting html files are added to the git repo, but should ideally be generated on fly from the md files.

The tool in the scripts for generating the html from md files is http://pandoc.org/MANUAL.html
@FloatingFront
Copy link
Author

Just as a suggestion, copied tutorial material structure from

https://github.com/absinthe-graphql/absinthe/tree/master/guides/tutorial

to

https://github.com/absinthe-graphql/absinthe_tutorial

with the following change suggestions:

  • added /src subdirectory to the /tutorial directory
  • put the *.md files into this /src subdirectory

(the *.md files will be the "source file" for generating the *.html files so nothing is changing on the help document creating front...)

created two scripts (either one will do - you choose which one you like better - note the resulting name difference of the generated *.html files) ,

  • convert-md-to-html.sh generates the *.html files into the parent directory
  • make-html-from-md.sh generates the *.md.html files into the parent directory

(again, the difference is in the naming of the resulting html files : *.html vs. *.md.html )

The resulting html files are added to the git repo, but should ideally be generated on fly from the md files, but that is more difficult to achieve and would need more changes - other projects are probably already have that sorted in some fashion.

The tool used by the scripts for generating the html from md files is http://pandoc.org/MANUAL.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants