gaelgirodon / markdown-to-document Goto Github PK
View Code? Open in Web Editor NEWA command-line tool to easily generate HTML documents from Markdown files
License: GNU General Public License v3.0
A command-line tool to easily generate HTML documents from Markdown files
License: GNU General Public License v3.0
With the --dest
option, we can only provide a directory.
Would be nice to have an option or an enhancement of the --dest
option to be able to rename the destination file. It'll prevent user to user more libs to move, rename or delete files.
My case is to compile README.md
to dist/index.html
.
And thanks for your lib, it's pretty nice ;)
When I run this command:
mdtodoc markdownfiles/*.md --dest dist --theme github --highlight-style atom-one-light,
I get no syntax highlighting for my code blocks
I would expect this to have syntax colouring for my html and javascript as below.
Example.md
const x = "hello"
console.log(x)
<!doctype html>
<html lang="en">
<body>
<div id="app">Placeholder.</div>
<script>
// do something here...
document.getElementById('app').innerHTML = 'hello world';
</script>
</body>
</html>
Technically this isn't a bug, but
for the benefit of using this plugin to link markdown files between each other-
it's important for tidy folder organisation when scaling.
markdownfiles/
index.md
cat1_files/
c1-1.md
c1-2.md
cat2_files/
c2-1.md
mdtodoc markdownfiles/* --dest dist/* --theme github --highlight-style atom-one-dark -l basic",
or
mdtodoc markdownfiles/* --dest dist/ --theme github --highlight-style atom-one-dark -l basic",
or
mdtodoc markdownfiles --dest dist --theme github --highlight-style atom-one-dark -l basic",
Expected output
/dist/
index.html
cat1_files/
c1-1.html
c1-2.html
cat2_files/
c2-1.html
Actual
`Error: Invalid source(s) (should be valid md files).
Your documentation themes do not work for me and solarized dark causes an actual error
The --highlight-style option can receive the name of a Hightlight.js style (file name without extension, e.g. solarized-dark) or the path to a custom style file (a local path or a HTTP URL).
[email protected] mdtodoc
mdtodoc markdownfiles/*.md --dest dist --theme github --highlight-style solarized-dark --layout layout/custom-layout.html
Error: Invalid highlight style 'solarized-dark': file not found or not readable.
at Style.validate (file:///C:/site/docs/node_modules/markdown-to-document/src/style.js:177:13)
at async Style.loadHighlightStyle (file:///C:/site/docs/node_modules/markdown-to-document/src/style.js:160:19)
at async Style.init (file:///C:/site/node_modules/markdown-to-document/src/style.js:77:28)
at async Processor.process (file:///C:/site/docs/node_modules/markdown-to-document/src/processor.js:63:5)
When I run this command:
mdtodoc markdownfiles/*.md --dest dist --theme github --highlight-style atom-one-light,
I get no syntax highlighting for my code blocks
I would expect this to have syntax colouring for my html and javascript as below.
Example.md
const x = "hello"
console.log(x)
<!doctype html>
<html lang="en">
<body>
<div id="app">Placeholder.</div>
<script>
// do something here...
document.getElementById('app').innerHTML = 'hello world';
</script>
</body>
</html>
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.