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

Deterministic page headers by exploring pages via rootPage.pages key #5

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

Conversation

thangngoc89
Copy link
Collaborator

@thangngoc89 thangngoc89 commented Jul 12, 2021

As discussed here #2 (comment)

This PR adds a new method for exploring all pages via new header in rootPage.pages. (as comma separated string, due to limitation of current YAML parser). The order specified in rootPage.pages will be used for rendering Sticky page headers. Page specific headers like hideInNav/hideInSearch are respected and aren't overrided.

There are 2 commits in this PR, the first one is for adding Typescript via JSDoc comments, you should skip it and look at the second commit here.

- This helps me to read code more easily
by making assumptions about the current type
and then change the assumption if I ever encounter a different
type of the same function/variables
- All types added in comments thus optional
Paradoc developers/users don't have to install any tools to
develop/use Paradoc
- To make use of Typescript's type intellisense you can open
Paradoc.js in any editor that support Typescript's Language Server
Protocol (for example: VSCode, Oni2)
- Adds a new method for exploring all pages via new header in rootPage.pages (as comma separated string, due to limitation of current YAML parser)
- The order specified in rootPage.pages will be used for rendering sticky page headers.
- Page specific headers like hideInNav/ hideInSearch are respected
@thangngoc89
Copy link
Collaborator Author

thangngoc89 commented Jul 12, 2021

Sorry for force pushing. I messed up with conflicts resolution.

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.

1 participant