Comments (3)
Sure we could accommodate that.
Could potentially just make the option clever enough to use whatever extension is written to the option ie:
entryFileName: "index.rst"
(use .rst).entryFileName: "index
(use default ext).
Just to confirm entryFileName
also effects all module index pages (but this might not be relevant to your use-case?
from typedoc-plugin-markdown.
Oh I see, I didn't realize the entry point applied to all module indexes, thanks for calling it out. Let me check if that would work with our pipeline with my team, I'll come back to you on that.
If that works, then your proposal would work fine, although I'm always wary of trying to make a configuration option "clever", because it tends to create edge cases. For instance, wouldn't it be a legitimate use case to have to have the entry point files named something like api.index
, expecting that the general .md
would be added on top of that? Because then either there is a list of "supported" output file extensions, and that becomes a burden for the library, or any /(*)\.(*)/
pattern is supported, with $1
the file name and $2
the extension, but then it might confuse some users who were relying on the previous behavior. If that is a concern, introducing an additional "dumb" config option enforces that this is a purely additive change, entirely opt-in.
And if that doesn't work out of the box and requires some work to be supported, then we might as well do the work to accommodate for the current behavior, and therefore no change would be required on you end.
I'll come back to you when I have a more precise idea of the next steps, and thanks for being so responsive!
from typedoc-plugin-markdown.
FYI have added an example of how to achieve this output with a local plugin. https://github.com/typedoc2md/typedoc-plugin-markdown-scratchpad/tree/main/issues/624.
from typedoc-plugin-markdown.
Related Issues (20)
- Duplicates in docs/functions (v4) HOT 2
- Param object trans head not ok HOT 2
- is it possible to reorder generated sections? HOT 3
- Broken links in some local wiki reference HOT 1
- postRenderAsyncJobs doesn't work in watch mode HOT 2
- Renamed Files Aren't Tracked in Index.md File HOT 2
- Provide the ability to update or remove section headers for comment tags HOT 3
- Parse functions into a table or a list HOT 3
- Add option to generate relative links with forward slashes in typedoc-plugin-markdown HOT 2
- Error: The docs folder does not exist when the `out` folder does not exists HOT 2
- vitepress example broken when cloned locally HOT 6
- v4.1 removes relative link HOT 2
- id in typedoc-sidebar.cjs incorrectly calculated HOT 2
- githubPages option does not generate .nojekyll file HOT 3
- TypeDoc exiting with unexpected error: Error: Debug Failure. False expression. HOT 2
- flattenOutputFiles is true, but the name structure should be text-text-text-text.md HOT 2
- Intra-page hash links to sections are incompatible with Docusaurus 3.4 HOT 3
- Examples block not being rendered HOT 4
- Sidebar 'typedoc-sidebar.cjs' is generated with backward slashes instead of forward slashes HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typedoc-plugin-markdown.