Skip to content

Commit

Permalink
Update: release 1.0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
yzane committed May 3, 2018
1 parent a3b52c6 commit f61068d
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 32 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
* Is it possible to insert page breaks? [#25](https://github.com/yzane/vscode-markdown-pdf/issues/25)
* Update: README
* FAQ: Page break
* Update: markdown-pdf.css
* Add: Meiryo to font-family

## 1.0.4 (2018/05/01)
* Fix: Display error message when downloading Chromium
Expand Down
7 changes: 7 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@

<!-- /TOC -->

<div class="page"/>

## 機能

以下の機能をサポートしています。
Expand All @@ -47,6 +49,7 @@ Markdown PDF をインストールして、Visutal Studio Code で Markdownフ

ダウンロードが上手くいかない場合や、Markdown PDF のバージョンアップの度にダウンロードするのを避けたい場合、[markdown-pdf.executablePath](#markdown-pdfexecutablepath) オプションでインストール済みの [Chrome](https://www.google.co.jp/chrome/) か Chromium を指定してください。

<div class="page"/>

## 使い方

Expand Down Expand Up @@ -437,6 +440,7 @@ Markdown PDF をインストールして、Visutal Studio Code で Markdownフ
- デフォルトの白い背景ではなく、透過によるスクリーンショットのキャプチャーを有効にします
- boolean. Default: false

<div class="page"/>

## FAQ

Expand Down Expand Up @@ -477,6 +481,7 @@ Visual Studio Code の `files.autoGuessEncoding` オプションを使うと、
<div class="page"/>
```

<div class="page"/>

## 既知の問題

Expand All @@ -493,6 +498,8 @@ Visual Studio Code の `files.autoGuessEncoding` オプションを使うと、
* Is it possible to insert page breaks? [#25](https://github.com/yzane/vscode-markdown-pdf/issues/25)
* Update: README
* FAQ: Page break
* Update: markdown-pdf.css
* Add: Meiryo to font-family

### 1.0.4 (2018/05/01)
* Fix: Display error message when downloading Chromium
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ This extension convert Markdown file to pdf, html, png or jpeg file.

<!-- /TOC -->

<div class="page"/>

## Features

Supports the following features
Expand All @@ -50,6 +52,7 @@ If you are behind a proxy, set the `http.proxy` option to settings.json and rest

If the download is not successful or you want to avoid downloading every time you upgrade Markdown PDF, please specify the installed [Chrome](https://www.google.co.jp/chrome/) or 'Chromium' with [markdown-pdf.executablePath](#markdown-pdfexecutablepath) option.

<div class="page"/>

## Usage

Expand Down Expand Up @@ -443,6 +446,7 @@ If the download is not successful or you want to avoid downloading every time yo
- Hides default white background and allows capturing screenshots with transparency
- boolean. Default: false

<div class="page"/>

## FAQ

Expand Down Expand Up @@ -483,6 +487,7 @@ Please use the following to insert a page break.
<div class="page"/>
```

<div class="page"/>

## Known Issues

Expand All @@ -499,6 +504,8 @@ Please use the following to insert a page break.
* Is it possible to insert page breaks? [#25](https://github.com/yzane/vscode-markdown-pdf/issues/25)
* Update: README
* FAQ: Page break
* Update: markdown-pdf.css
* Add: Meiryo to font-family

### 1.0.4 (2018/05/01)
* Fix: Display error message when downloading Chromium
Expand Down
68 changes: 36 additions & 32 deletions sample/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,10 @@
* Markdown PDF CSS
*/

body {
font-family: "Meiryo", "Segoe WPC", "Segoe UI", "SFUIText-Light", "HelveticaNeue-Light", sans-serif, "Droid Sans Fallback";
}

pre {
background-color: #f8f8f8;
border: 1px solid #cccccc;
Expand Down Expand Up @@ -371,6 +375,12 @@
font-size: inherit;
}

/* Page Break : use <div class="page"/> to insert page break
-------------------------------------------------------- */
.page {
page-break-after: always;
}

</style>

</head>
Expand Down Expand Up @@ -398,6 +408,7 @@ <h2 id="table-of-contents">Table of Contents</h2>
<li><a href="#special-thanks">Special thanks</a></li>
</ul>
<!-- /TOC -->
<div class="page"/>
<h2 id="features">Features</h2>
<p>Supports the following features</p>
<ul>
Expand All @@ -415,8 +426,10 @@ <h2 id="features">Features</h2>
<h2 id="install">Install</h2>
<p>Chromium download starts automatically when Markdown PDF is installed and Markdown file is first opened with Visutal Studio Code.</p>
<p>However, it is time-consuming depending on the environment because of its large size (~ 170Mb Mac, ~ 282Mb Linux, ~ 280Mb Win).</p>
<p>During downloading, <code>Installing Puppeteer ...</code> is displayed in the status bar.</p>
<p>If the download is not successful or you want to avoid downloading every time you upgrade Markdown PDF, please specify the installed 'Chromium' or 'Chrome' with <a href="#markdown-pdfexecutablepath">markdown-pdf.executablePath</a> option.</p>
<p>During downloading, the message <code>Installing Chromium</code> is displayed in the status bar.</p>
<p>If you are behind a proxy, set the <code>http.proxy</code> option to settings.json and restart Visual Studio Code.</p>
<p>If the download is not successful or you want to avoid downloading every time you upgrade Markdown PDF, please specify the installed <a href="https://www.google.co.jp/chrome/">Chrome</a> or 'Chromium' with <a href="#markdown-pdfexecutablepath">markdown-pdf.executablePath</a> option.</p>
<div class="page"/>
<h2 id="usage">Usage</h2>
<h3 id="command-palette">Command Palette</h3>
<ol>
Expand Down Expand Up @@ -987,6 +1000,7 @@ <h4 id="markdown-pdfomitbackground"><code>markdown-pdf.omitBackground</code></h4
<li>Hides default white background and allows capturing screenshots with transparency</li>
<li>boolean. Default: false</li>
</ul>
<div class="page"/>
<h2 id="faq">FAQ</h2>
<h3 id="how-can-i-change-emoji-size">How can I change emoji size ?</h3>
<ol>
Expand All @@ -996,61 +1010,51 @@ <h3 id="how-can-i-change-emoji-size">How can I change emoji size ?</h3>
<span class="hljs-attribute">height</span>: <span class="hljs-number">2em</span>;
}
</div></code></pre>
<h3 id="tip-auto-guess-encoding-of-files">Tip: Auto guess encoding of files</h3>
<h3 id="auto-guess-encoding-of-files">Auto guess encoding of files</h3>
<p>Using <code>files.autoGuessEncoding</code> option of the Visual Studio Code is useful because it automatically guesses the character code. See <a href="https://code.visualstudio.com/updates/v1_11#_auto-guess-encoding-of-files">files.autoGuessEncoding</a></p>
<pre class="hljs"><code><div><span class="hljs-string">"files.autoGuessEncoding"</span>: <span class="hljs-literal">true</span>,
</div></code></pre>
<h3 id="tip-output-directory">Tip: Output directory</h3>
<h3 id="output-directory">Output directory</h3>
<p>If you always want to output to the relative path directory from the Markdown file.</p>
<p>For example, to output to the &quot;output&quot; directory in the same directory as the Markdown file, set it as follows.</p>
<pre class="hljs"><code><div><span class="hljs-string">"markdown-pdf.outputDirectory"</span> : <span class="hljs-string">"output"</span>,
<span class="hljs-string">"markdown-pdf.outputDirectoryRelativePathFile"</span>: <span class="hljs-literal">true</span>,
</div></code></pre>
<h3 id="page-break">Page Break</h3>
<p>Please use the following to insert a page break.</p>
<pre class="hljs"><code><div><span class="hljs-tag">&lt;<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"page"</span>/&gt;</span>
</div></code></pre>
<div class="page"/>
<h2 id="known-issues">Known Issues</h2>
<h3 id="markdown-pdfstyles-option"><code>markdown-pdf.styles</code> option</h3>
<ul>
<li>Online CSS (https://xxx/xxx.css) is applied correctly for JPG and PNG, but problems occur with PDF. <a href="https://github.com/yzane/vscode-markdown-pdf/issues/67">#67</a></li>
</ul>
<h2 id="release-notes"><a href="CHANGELOG.md">Release Notes</a></h2>
<h3 id="103-20180430">1.0.3 (2018/04/30)</h3>
<h3 id="105-20180503">1.0.5 (2018/05/03)</h3>
<ul>
<li>
<p>Fix: Support <a href="https://code.visualstudio.com/docs/editor/multi-root-workspaces">Multi-root Workspaces</a> with <a href="#markdown-pdfstyles">markdown-pdf.styles</a> option</p>
<li>Improve: Exception handling</li>
<li>Improve: Chromium install check</li>
<li>Add: Page break
<ul>
<li>Japanese font is not good <a href="https://github.com/yzane/vscode-markdown-pdf/issues/79">#79</a></li>
<li>relative stylesheet paths are not working when multiple folders in workspace <a href="https://github.com/yzane/vscode-markdown-pdf/issues/68">#68</a></li>
<li>Is it possible to insert page breaks? <a href="https://github.com/yzane/vscode-markdown-pdf/issues/25">#25</a></li>
</ul>
</li>
<li>
<p>Fix: <a href="#markdown-pdfstyles">markdown-pdf.styles</a> option</p>
<li>Update: README
<ul>
<li>[BUG] Custom PDF style not being used <a href="https://github.com/yzane/vscode-markdown-pdf/issues/35">#35</a></li>
<li>How to change font size of generated pdf <a href="https://github.com/yzane/vscode-markdown-pdf/issues/40">#40</a></li>
<li>How do you change font-family? <a href="https://github.com/yzane/vscode-markdown-pdf/issues/64">#64</a></li>
<li>FAQ: Page break</li>
</ul>
</li>
<li>
<p>Improve: Support <a href="https://code.visualstudio.com/docs/editor/multi-root-workspaces">Multi-root Workspaces</a> with <a href="#markdown-pdfoutputdirectory">markdown-pdf.outputDirectory</a> option</p>
<li>Update: markdown-pdf.css
<ul>
<li>How do I specify a relative output directory? <a href="https://github.com/yzane/vscode-markdown-pdf/issues/29">#29</a></li>
<li>Add: Meiryo to font-family</li>
</ul>
</li>
<li>
<p>Fix: File encoding</p>
<ul>
<li>Not correctly rendering Windows 1252 encoding <a href="https://github.com/yzane/vscode-markdown-pdf/issues/39">#39</a></li>
<li>First H1 header not recognized if file starts with UTF-8 BOM <a href="https://github.com/yzane/vscode-markdown-pdf/issues/44">#44</a></li>
</ul>
</li>
<li>
<p>Fix: Can not convert pdf <a href="https://github.com/yzane/vscode-markdown-pdf/issues/76">#76</a></p>
</li>
<li>
<p>Add: <a href="#markdown-pdfoutputdirectoryrelativepathfile">markdown-pdf.outputDirectoryRelativePathFile</a> option</p>
</li>
<li>
<p>Add: <a href="#markdown-pdfstylesrelativepathfile">markdown-pdf.stylesRelativePathFile</a> option</p>
</li>
<h3 id="104-20180501">1.0.4 (2018/05/01)</h3>
<ul>
<li>Fix: Display error message when downloading Chromium</li>
<li>Improve: Chromium install. Display download progress on status bar</li>
</ul>
<h2 id="license">License</h2>
<p>MIT</p>
Expand Down
Binary file modified sample/README.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified sample/README.pdf
Binary file not shown.
Binary file modified sample/README.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f61068d

Please sign in to comment.