pentialabs / crust-io Goto Github PK

We'll need a search index.

Should be fairly simple to do by leveraging: http://lunrjs.com/
(Here's an example on where it has been implemented)

Initial thoughts:

• Should create a search-index.json for site root.
• Site maintainer is free to implement the search feature if he/she wants to.
• We should add a sample search feature inside generator-crust
• Think about how search result page fits into page structure.

We should provide a setting that makes a page in the source accessible when user is offline.

Initial thoughts:

• It should be done by a simple configuration setting inside config.yaml:

  availableOffline: true

• When traversing tree, we should create a Service Worker manifest with the pages available offline included.

Expected behavior

When creating a link in markdown that contains parenthesis I would like it to render it as one could expect.

Actual behavior

When creating a link in markdown that contains parenthesis the formatting isn't correct.

Steps to reproduce the behavior

Create a page with a link containing parenthesis, generate and observe.

There's absolutely no JavaScript setup in the current workflow. An newcomer would probably like our thoughts on how to make JavaScript-components work with the rest of the setup, so we should definitely do an example on that as well.

Sometimes we need to pass a long custom variables to pages that we can react on for presentational purposes.

For instance, I'd like to have some sort of custom ID on my Standard Operating Procedures covers in the Pentia Standard Operating procedures compendium. Right now I'm only getting the folder title and a bit of information about the path of the page, but if I'd like to annotate a number that goes along with the SOPs there's no way for me to do so.

config.yaml should have a crustVars property which is an object holding data that should be exposed to the frontend while generating the product HTML.

For some reason sorting doesn't work when compiling site on windows.

To utilize HTML product for use as a SPA it would be very useful to have a JSON-file in each of the levels in the HTML product, which tells everything about current context. That being a list of subpages, the last modified dates etc.

By having this in place, it would be fairly easy to create rich SPA integration to the static HTML product.