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

Docs navigation #1156

Merged
merged 4 commits into from Mar 25, 2018

Conversation

Projects
None yet
3 participants
@UziTech
Copy link
Member

commented Mar 22, 2018

Marked version: latest

Markdown flavor: Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a

Description

This PR adds a ribbon that links to the github repo and adds a link to marked icon back to the README.md

image

Contributor

  • Test(s) exist to ensure functionality and minimize regresstion (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR
@UziTech

This comment has been minimized.

Copy link
Member Author

commented Mar 22, 2018

We should probably also make a way to be able to link to different parts of the site.

Because this is a SPA there is no way to view AUTHORS.md without clicking on a link in https://marked.js.org/

@joshbruce

This comment has been minimized.

Copy link
Member

commented Mar 22, 2018

@UziTech: I was wondering if a SPA would be the desired approach or not. Namely because of the double-anchor problem. /# (makes it a SPA) /#something#inline (becomes a different problem to solve).

One way to do it would be to use multiple index.html file within directories. Or, use something like VueJS or Angular.

@joshbruce joshbruce requested a review from styfle Mar 22, 2018

@joshbruce

This comment has been minimized.

Copy link
Member

commented Mar 22, 2018

Would also be nice if the README still linked to different documents. Like having two links in the usage section - one to the advanced and another to the pro.

@UziTech

This comment has been minimized.

Copy link
Member Author

commented Mar 22, 2018

Namely because of the double-anchor problem.

Ya I through together a hashchange router at UziTech@62b697a but it has some problems with the back and forward buttons.

I'm thinking the index files in directories would be a better solution

@styfle

styfle approved these changes Mar 22, 2018

Copy link
Member

left a comment

This is an improvement

@styfle

This comment has been minimized.

Copy link
Member

commented Mar 22, 2018

I was thinking of using urls like marked.js.org/#page=AUTHORS.md which would render the AUTHORS.md file as html.

This would give us a way to render additional non-docs pages that are not part of the docs SPA such as marked.js.org/demo.html...see this: #64

@joshbruce

This comment has been minimized.

Copy link
Member

commented Mar 22, 2018

That alternative make my UX brain hiccup a bit...to computer, not enough human, if that makes sense. Same issues with ?p=5 from single-page server-side. We might be able to use just the router from something like Angular...that's all we're really looking for.

A router that doesn't break that back and forward buttons, while also allowing for inline anchors.

Still thinking the cheapest and easiest would be multiple index.html files:

/index.html <- readme with demo (that could be cool) see Haskell https://www.haskell.org

/authors/index.html <- renders the md

/code-of-conduct

/contributing

/license

/publishing

/using <- display readme again
  /advanced
  /pro

Just clean and simple human readable urls. Only drawback is that there would be some duplication of code...but I don't think it's that big of a deal for such a small static site.

??

@joshbruce

This comment has been minimized.

Copy link
Member

commented Mar 22, 2018

Just realized the demo thing is what #64 is about. :)

@styfle

This comment has been minimized.

Copy link
Member

commented Mar 22, 2018

Or we could avoid re-inventing the wheel and go with this: https://docsify.js.org

@joshbruce

This comment has been minimized.

Copy link
Member

commented Mar 22, 2018

Interesting. Could we use Jekyll (native GitHub Pages). Given our current focus - we could use the marked site to showcase some of our personal projects...touching on the professional growth itch.

I've been working on a design system based on the USWDS for 8fold and the practitioner sites: https://www.npmjs.com/package/8fold-web-assets

Definitely thinking starting a separate repo would be good as well. I don't mind reimagining the wheel so long as it helps us grow professionally in an environment that's not mission critical to us eating. :)

@styfle styfle merged commit ad6c7f9 into markedjs:master Mar 25, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@UziTech UziTech deleted the UziTech:docs-navigation branch Apr 5, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.