Skip to content
This repository was archived by the owner on Feb 15, 2022. It is now read-only.

Generalize markdown driven page component #222

Closed
4 of 5 tasks
ghost opened this issue Mar 25, 2021 · 4 comments
Closed
4 of 5 tasks

Generalize markdown driven page component #222

ghost opened this issue Mar 25, 2021 · 4 comments

Comments

@ghost
Copy link

ghost commented Mar 25, 2021

"Install OCaml" demonstrates a markdown driven page. Generalize it's implementation, attempting to deal with all of the following issues:

  • Use a generic page component which renders all markdown files within a given directory (or directory subtree, if preferred). getStaticPaths should help in implementing this
  • Consider how the markdown file names will map to urls
  • Initially use a tag for all links
  • Refactor link generation to use NextJS Link component for internal links or accept limitations of not using NextJS Link component in this situation.
  • Improve general text and code block styling. Do not address highlighting in this issue. Highlighting will be dealt with in Implement code highlighting #137.

Note: Create a follow-up issue to design and implement the mobile rendering of the table of contents.

@ghost ghost self-assigned this Mar 25, 2021
@ghost ghost changed the title Generalized markdown driven page component Generalize markdown driven page component Mar 26, 2021
This was referenced Mar 31, 2021
@ghost
Copy link
Author

ghost commented Apr 3, 2021

  • Use a generic page component which renders all markdown files within a given directory (or directory subtree, if preferred). getStaticPaths should help in implementing this
  • Consider how the markdown file names will map to urls
  • Initially use a tag for all links

These were all done in #252

@ghost
Copy link
Author

ghost commented Apr 22, 2021

Refactor link generation to use NextJS Link component for internal links or accept limitations of not using NextJS Link component in this situation.

As part of #296 , I chose to use rehype-stringify, which does not allow for React elements. Since we cannot use React elements, I have chosen to accept the limitations of not using NextJS Link component in the body of rendered markdown.

@agarwal agarwal unassigned ghost Apr 22, 2021
@agarwal
Copy link
Member

agarwal commented May 11, 2021

@kanishka-work Consider closing this and making followup issues for design improvements.

@agarwal agarwal assigned ghost May 11, 2021
@ghost
Copy link
Author

ghost commented May 11, 2021

Improve general text and code block styling. Do not address highlighting in this issue. Highlighting will be dealt with in #137.

We'll create a follow-up issue for this.

This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant