fuxingloh / contented Goto Github PK

What would you like to be added:

As per title, we should think about supporting parsing image in packages/contented-pipeline-md — supporting them properly in the true Contented way — the Git way.

Why is this needed:

Although contented started out as "Contented is a Markdown-based authoring workflow & processor that encourage developer authoring within its contextual Git repository." Where content is mostly text or diagrams that are easily managed in a Git repository in a single file. However, our uses cases are expanding where we need to support more complex content types such as images.

Using image within Markdown although popular is hard to manage in a Git repository. It is hard to track changes and diffs. You can't easily see the changes in a PR. It is also hard to manage the image assets in a Git repository.

What would you like to be added:

• Parse js/ts documentations into Markdown into HTML
• Parse jest documentations/comments into Markdown into HTML (Better DX, instead of parsing markdown into jest)
• Parse GRPC documentations/comments into Markdown into HTM

Why is this needed:

Contextual documentations.

/triage accepted
/area contented-processor

What would you like to be added:

Generate index.d.ts based on the produced index.js for downstream DX.

Why is this needed:

For the DX of the consumer of contented build.

What would you like to be added:

Move to @parcel/watcher instead of chokidar.

Why is this needed:

Check out https://www.npmjs.com/package/@parcel/watcher for move reason why we should.

/triage accepted
/area contented

What would you like to be added:

As per the title, we should support parsing <svg></svg>.

/area contented-processor

What would you like to be added:

For end-to-end "shift left authoring" to work, we need to embed "contented" into our CI/CD workflow. Other than generating a preview of the markup website, we also need to highlight to reviewers what pages have changed. Which sources/files were changed.

Why is this needed:

Shift-left excellency.

What would you like to be added:

Compute filename and use it as title if "title" isn't provided? We should also slugify file name when used for paths.

What would you like to be added:

Given this:

# My Heading

Contented

We should parse # My Heading as a title and remove it from the content body.

Why is this needed:

To keep authoring more natural, not all MD requires frontmatter.

What would you like to be added:

As per title.

Why is this needed:

Useful feature to have since some data is better represented in a tabular form. For example, a glossary, schema, etc.

### Tasks
- [ ] Automatically check broken links within an entire collection in Contented
- [ ] Link via non-parsed urls.

What would you like to be added:

On Markdown, we should support <b>Bolded</b> as HTML instead of escaping it.

Debatable and might cause unnecessary complexity as it's not prose-friendly. Markdown is prose friendly where semantics are little, making writing the focus. HTML isn't.

/area contented-processor

What would you like to be added:

Improve how mermaid is handled on contented-preview, currently it looks for "div.mermaid" and loads by replacing the div on page load. This is difficult when the site state change and you need to reload mermaid. We should keep the raw data of "div.mermaid" around so that we can reuse it when the state change.

This might not be as simple and require working on the unified plugin to keep it in data attributes.

/area contented-preview

What would you like to be added:

https://github.com/google/typograms

Why is this needed:

WYSIWUG Graphs

What would you like to be added:

NextJS addon to automatically reload/rebuild contented dist.

Why is this needed:

While contented-preview has this feature included, for users that want to build a custom website without utilizing contented-preview would have a hard time configuring "auto refreshed live-preview" of the markdown website.

What would you like to be added:

Supply a link "Edit on GitHub" where the content can be automatically resolved.

Why is this needed:

For editing QOL.

low priority

What would you like to be added:

• Provide a way to link to other pages

Why is this needed:

• Currently, devs have to declare links that will be transformed to

  Foo [bar](/another-page#baz)

• However this will result in a reload of the site

What happened:

When doing something like:

## [A header that's a link](./something.md)

The header does not render on contented write.

If however you do a combination of links and text in the header like so:

## Half a [header](something.md)

The text half render correctly, but the link will only appear on hover.

A visual example which is also reproduced below:

---
title: Lorem 1
---

## This is a heading that is not a link

## [This is a heading that is a link](http://tempore-serpens.net/temperatvirentem)

## Half a link [here:](http://tempore-serpens.net/temperatvirentem)
## [Another: ](http://tempore-serpens.net/temperatvirentem), after a link

## There is headings above this title that is a link that is not shown.

[Normal link seems to work](http://tempore-serpens.net/temperatvirentem)

What you expected to happen:

The heading to render as expected, with the link shown in header style if possible.

How to reproduce it (as minimally and precisely as possible):

https://github.com/cwkang1998/contented-bug-linked-heading

Anything else we need to know?:

What would you like to be added:

• Throw helpful error if pipeline.collection[0] is undefined
  
• E.g. "The xxxxx could not be found. Did you forget to yyyyy?" or "Failed to resolve path to zzzzz"

Why is this needed:

• Devs can fix the missing configs faster

What would you like to be added:

Due to deprecated, let's remove it asap.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

• bump(deps): update @eslint to v9 (major) (@eslint/js, eslint)
• bump(deps): update dependency eslint-plugin-unused-imports to v4
• bump(deps): update dependency shiki to v1
• bump(deps): update dependency turbo to v2
• 🔐 Create all pending approval PRs at once 🔐

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• bump(deps): update actions/checkout action to v4.1.7
• bump(deps): update dependency @heroicons/react to v2.1.4
• bump(deps): update dependency @types/lodash to ^4.17.6
• bump(deps): update dependency next to v14.2.4
• bump(deps): update dependency postcss to v8.4.39
• bump(deps): update dependency tailwindcss to v3.4.4
• bump(deps): update dependency unified to ^11.0.5
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• bump(deps): update dependency @babel/generator to ^7.24.7
• bump(deps): update dependency @types/mdast to ^4.0.4
• bump(deps): update dependency esbuild to ^0.21.5
• bump(deps): update dependency lint-staged to ^15.2.7
• bump(deps): update dependency ts-jest to v29.1.5
• bump(deps): update dependency turbo to ^1.13.4
• bump(deps): update dependency debounce to ^2.1.0
• bump(deps): update dependency prettier to ^3.3.2
• bump(deps): update dependency prettier-plugin-tailwindcss to ^0.6.5
• bump(deps): update dependency typescript-eslint to ^7.14.1
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• bump(deps): update dependency minimatch to v9

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

What would you like to be added:

Contented is a powerful Markdown-based authoring workflow, but it currently lacks the ability to integrate custom content rendering easily. Additionally, it would be beneficial to have a built-in feature to pull images from a Content Delivery Network (CDN) like GitHub assets to optimize loading times and improve the overall user experience.

I propose a new feature called "Contented Plugin Directives" that allows developers to create and use a plugin-like system to render lightweight content, enhancing the Markdown content in a more interactive and visually appealing way.

Example below.

```[github-snippet]
https://github.com/BirthdayResearch/contented/blob/04e05562b4df341aa3bf9862fb2716e55a6c18d0/packages/contented-pipeline-md/src/MarkdownPipeline.ts#L33-L37
```

What would you like to be added:

https://github.com/google/typograms

Why is this needed:

WYSIWUG Graphs

What happened:

Page navigation (left side) jumps when content overflow, it should stay the same position regardless of content overflow.

What you expected to happen:

Not to jump!

How to reproduce it (as minimally and precisely as possible):

https://contented.dev

Anything else we need to know?:

It's annoying.

/triage accepted
/area contented-preview

What would you like to be added:

As Contented is an excellent Markdown-based authoring workflow that allows developers to focus on writing and maintaining documentation, it would be beneficial to have a Presentation Mode to improve the way we share and present our authored content.

I propose a new feature called "Contented Presentation Mode" which allows users to easily toggle between presentation and reading modes. This feature should enable users to pick existing prose from their domain-specific repositories for presentation purposes.

Key features of the Contented Presentation Mode:

• Toggle presentation mode: A simple user interface to switch between reading (linear) and presentation modes (slides).
• Pick existing prose: A mechanism to select existing Markdown content from the repositories and add them to the presentation deck that you can use for later presentations. (Using localstorage, to keep it simple)
• Seamless navigation: Intuitive navigation controls for easy traversal between the presentation slides.
• Export options: Export the presentation to popular formats like PDF or HTML.
• Customizable presentation templates: A set of built-in presentation templates and the ability to create custom templates to match the organization's branding and style. (This is not important)

Why is this needed:

Contented Presentation Mode will not only enhance the authoring experience but also facilitate better sharing and presentation of the authored content.

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

What would you like to be added:

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

Why is this needed:

Admonition is a custom standard for contented, this is a well establish alternative.

What would you like to be added:

Use NextNProgress for content-preview.

Why is this needed:

SPA navigating to content has no visual cue, NextNProgress adds it.

What would you like to be added:

While [api](../03-api) is sanitized as [api](../api), # should not be sanitized by Pipeline.prefix. To allow deep linking of content sections. Keeping # intact.

- `[content](../03-content#header)` parsed as `[content](../content-header)`
+ `[content](../03-content#header)` parsed as `[content](../content#header)`