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

Clean docs #9

Closed
wants to merge 7 commits into from
Closed

Clean docs #9

wants to merge 7 commits into from

Conversation

pspeter3
Copy link

@pspeter3 pspeter3 commented Nov 7, 2017

Based on this tweet, I've updated the transformation script and the contents of the files.

Start the package from a clean slate.
Now developers can run `npm start` to execute the build script.
Use TypeScript to make sure all cases are handled.
This cleans the markdown to be more normal and generates the HTML from that.
The tables were incorrect.
While marked generated the correct content, GFM did not.
It seems like nested lists are a mistake and asterisks should be preserved.
Copy link
Collaborator

@amazingrando amazingrando left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the effort on this. I haven't had the time myself and I appreciate the help. There are a couple of things before I can merge this:

  • Indicators for aspects are missing. Currently <span class="aspect"> marks them. I'd like to retain a class to indicate them, with a preference for something like <em class="aspect">.
  • I don't know the scripting setup that you have. Could you document it further? And is it something that could be run in parallel with the Gulp tasks already in the project? (I'm all for using cool and useful things, I just need an introduction.)

@pspeter3
Copy link
Author

pspeter3 commented Dec 4, 2017

So my goal was to largely replace the need for the Gulp work. I do think there are two goals though. One to have clean Markdown, and one to have markdown which works for the FATE SRD site. I did this because you asked me on Twitter but it isn't strictly required. I think you should keep your system if it works.

My end goal is actually to try and create a website using Gitbook so I can have local search.

@amazingrando
Copy link
Collaborator

My end goal is actually to try and create a website using Gitbook so I can have local search.

Nice goal! Sounds useful.

@pspeter3 pspeter3 closed this Dec 20, 2022
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