gaelgirodon / markdown-to-document Goto Github PK

View Code? Open in Web Editor NEW

41.0 41.0 5.0 878 KB

A command-line tool to easily generate HTML documents from Markdown files

License: GNU General Public License v3.0

JavaScript 95.31% CSS 3.33% HTML 1.36%

cli document docx html markdown merge mermaid pdf word

markdown-to-document's People

Contributors

Stargazers

Watchers

Forkers

aboutimage arnaudbuchholz javiercuba shinhyo tigerc10

markdown-to-document's Issues

text in mermaid diagrams show incomplete

env

docker: node:lts-alpine3.10

cli

mdtodoc open_doc.md -l "page" -t "github" -s "atom-one-light" --numbered-headings --code-copy --mermaid

image

PS: diagram render correctly On win10 & v12.19.0 of same command

them - solarized dark - as suggested in your documentation causes error

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)

No automatic syntax highlighting for code blocks

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

Some js file stuf here

const x = "hello"
console.log(x)

Some html stuff here...

<!doctype html>
<html lang="en">
<body>
  <div id="app">Placeholder.</div>

  <script>
    // do something here...
    document.getElementById('app').innerHTML = 'hello world';
  </script>
</body>
</html>

Scaling - retaining original directories in output would be very useful

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.

Input:

markdownfiles/
  index.md

  cat1_files/
    c1-1.md
    c1-2.md

  cat2_files/
    c2-1.md

build

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).

Rename dest file

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 ;)

Syntax highlighting not colouring code block

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

Some js file stuf here

const x = "hello"
console.log(x)

Some html stuff here...

<!doctype html>
<html lang="en">
<body>
  <div id="app">Placeholder.</div>

  <script>
    // do something here...
    document.getElementById('app').innerHTML = 'hello world';
  </script>
</body>
</html>

gaelgirodon / markdown-to-document Goto Github PK

markdown-to-document's People

Contributors

Stargazers

Watchers

Forkers

markdown-to-document's Issues

env

cli

image

Some js file stuf here

Some html stuff here...

Input:

build

Some js file stuf here

Some html stuff here...

Recommend Projects

Recommend Topics

Recommend Org