Skip to content

Output a "fully rendered" markdown document#48

Merged
pmolodo merged 1 commit intomainfrom
pmolodowitch/output-combined-markdown-with-title-page
Apr 9, 2026
Merged

Output a "fully rendered" markdown document#48
pmolodo merged 1 commit intomainfrom
pmolodowitch/output-combined-markdown-with-title-page

Conversation

@pmolodo
Copy link
Copy Markdown
Contributor

@pmolodo pmolodo commented Apr 7, 2026

...that has been processed through pandoc.

The input and output format are both .md, so the only thing that's changed are pandoc-specific things, like adding a title page and table of contents.

Note that for the table of contents to render in md properly, we must use github-flavored-markdown.

@OleksiyPuzikov
Copy link
Copy Markdown
Contributor

From the very quick overview, LGTM - thanks @pmolodo

I noticed the change in the expected Markdown requirements, I assume this was tested.

@pmolodo
Copy link
Copy Markdown
Contributor Author

pmolodo commented Apr 7, 2026

I noticed the change in the expected Markdown requirements, I assume this was tested.

I meant to mark this as DRAFT, as I'm working on a detailed comparison of what changes when switching to gfm. Short summary is that it DOES result in changes in html/pdf, but thus far it seems to be fairly minor / cosmetic stuff (ie, in html, characters are now replaced with &quot;, insertion of <span> tags inside of some <a> tags...)

@pmolodo pmolodo changed the title Output a "fully rendered" markdown document DRAFT: Output a "fully rendered" markdown document Apr 7, 2026
@pmolodo pmolodo force-pushed the pmolodowitch/output-combined-markdown-with-title-page branch 4 times, most recently from e43a0bd to 1fc43f3 Compare April 8, 2026 17:52
Builds a .md output by default alongside HTML/PDF/docx, using pandoc
to apply shared transforms (title page, TOC, filters).
Disable with --no-md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@pmolodo pmolodo force-pushed the pmolodowitch/output-combined-markdown-with-title-page branch from 1fc43f3 to a7392bd Compare April 8, 2026 18:28
@pmolodo
Copy link
Copy Markdown
Contributor Author

pmolodo commented Apr 8, 2026

So, after realizing that our current combined_spec.md does not have a consistent markdown style (it's a mix of markdown (pandoc's own markdown variant) and gfm (github-flavored-markdown), and a few attempts to unify it for consistency, I opted for this current less-invasive change for now. It only sets the format of the final "output" aousd_core_spec.md to be gfm.

Will file a issue to make markdown more consistent, targeting post-1.1

@pmolodo
Copy link
Copy Markdown
Contributor Author

pmolodo commented Apr 8, 2026

New version doesn't change any previous outputs, but just adds a .md (with title page and TOC).

Removing draft, ready for review.

@pmolodo pmolodo changed the title DRAFT: Output a "fully rendered" markdown document Output a "fully rendered" markdown document Apr 8, 2026
@pmolodo pmolodo requested a review from OleksiyPuzikov April 8, 2026 19:04
@pmolodo pmolodo merged commit 3e513d4 into main Apr 9, 2026
1 check passed
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.

3 participants