Comments (4)
Implemented some options and <br/>
in v0.4.0 to get what you want.
from docfxmarkdowngen.
The problem in this specific case seems to be that the Docusaurus' markdown does not supported ordered lists like 1)
,2)
, while using 1.
,2.
does work:
/// <summary>
/// Also does nothing.
/// 1) 1
/// 2) 2
///
/// but:
/// 1. 1
/// 2. 2
/// </summary>
The problem with forcing a newline on every newline in the xmldoc would be that a sentence split across multiple lines in the xmldoc would then also be split over multiple lines.
I guess some options like forcing a newline always or only when the line ends with a specific character could be implemented.
from docfxmarkdowngen.
True true, but I didn't just mean for lists, I meant for line breaks in general. Like if my documentation says:
This is a statement.
This is another statement.
Here is a separate statement.
Let's pretend that in this case the formating is important..
In docfx it renders as written above, but in Docusaurus that will render as:
This is a statement. This is another statement. Here is a separate statement.
I think with code comments the original intended formating should be preserved...
But now actually as I write this, I'm no longer sure 🤣 ... Feel free to close this issue, just wanted to explain my thought process...
from docfxmarkdowngen.
This is great! Seems to be working!
from docfxmarkdowngen.
Related Issues (10)
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.
linebreak support
from docfxmarkdowngen.