harshkapadia2 / asciidoctor-jet Goto Github PK

• Section: Serving The Site Locally
• Additions
  • NPM package serve
  • python3 -m http.server

• Change the title of the Table of Contents (ToC) from 'Table of Contents' to the title of the document.
• Conditions to be met to make this change
  • When the ToC is on the left/right.
  • When the header is not visible.
• Things to keep in mind
  • Handling of overflow of extra-long titles.
  • Detection of whether the ToC is on the left/right or not.
    • It doesn't make sense to make the change if the ToC is in the normal flow of the document.
  • Changing the ToC title back to 'Table of Contents' from the document title when a left/right aligned ToC goes to its normal flow in the document.

Current behaviour (top left)

Expected behaviour (top left)

No change to ToC title if doc title is visible

No change to ToC title if ToC is in the normal flow of the document

Look into porting other frameworks into Asciidoctor Jet.

Credits: Chirag Nayyar

I was working on the README and thought this should have a file structure like this:

util
 ┣ build.sh
 ┣ catchup-number.js
 ┣ get-latest-catchup-number.js
 ┗ get-next-catchup-number.js

What do you think?

• Add steps to include individual features from Asciidoctor Jet.
• Make sure to add additional steps required to only add the individual feature.

• Check if https://github.com/jirutka/asciidoctor-html5s makes a considerable difference in the output HTML by making it more semantic and accessible.
• Take stock of the issues with the extension before moving forward.
• Beware of the original (default) styling of Asciidoctor and the new styling added onto it by Asciidoctor Jet both getting affected.

Footer text and links are not visible in light mode.

Reason being - You have use-cases now, a template would be a good user experience.

• Highlight.js outputs the following in the console.
  • Deprecated as of 10.7.0. highlightBlock will be removed entirely in v12.0
  • Deprecated as of 10.7.0. Please use highlightElement now.
• Handle this and make necessary changes.
  • Might have to raise an issue on the Asciidoctor repo.

• Every save of a .adoc file should trigger a build.
• Remember to support other Asciidoctor extensions.
• Make it easy to add more extensions to watch over.
  • Add documentation for this.
• Maybe look into not only just building on save, but serving as well.
• Might help: OurTechCommunity/catchup#6