Skip to content

Commit

Permalink
Release(v2.0.0): mdEditor
Browse files Browse the repository at this point in the history
  Append minor config fixes
  Append minor markdown edits
  • Loading branch information
killshot13 committed Oct 23, 2023
1 parent a46aa7b commit f1ab91a
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 29 deletions.
68 changes: 40 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,35 +71,41 @@ If for some reason you did not receive a prompt or have already closed the notif

--> [vscode-pandoc](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vscode-pandoc)

### Tree View

Now, using this diagram, verify the file structure of your local mdEditor is free from any discrepancies.

**Tree View**
_mdEditor_
\+---.github-templates (+6)
|
+---.vscode
| `settings.json`
| `extensions.json`
|
+---images
| `mdEditor.gif` (+3)
|
+---md
| `test.txt`
|
+---styles
| `style.css`
| `syntax.md`
|
|`.markdownlint.json`
|`mdEditor.code-workspace`
|`README.md` (+2)
\---

**NOTE: On Linux you must uncomment the `pandoc.htmlOptString` in the `mdEditor.code-workspace` file. The current version, which uses Windows OS file separators, must be replaced with the Linux version; otherwise, the css styles will not be applied correctly.**

Installation is complete.
Nice job!
##### _mdEditor/_

- [.github](./.github)
- [ISSUE_TEMPLATE](./.github/ISSUE_TEMPLATE)
- [bug_report.md](./.github/ISSUE_TEMPLATE/bug_report.md)
- [custom.md](./.github/ISSUE_TEMPLATE/custom.md)
- [feature_request.md](./.github/ISSUE_TEMPLATE/feature_request.md)
- [CONTRIBUTING.md](./.github/CONTRIBUTING.md)
- [ISSUE_TEMPLATE.md](./.github/ISSUE_TEMPLATE.md)
- [PULL_REQUEST_TEMPLATE.md](./.github/PULL_REQUEST_TEMPLATE.md)
- [.vscode](./.vscode)
- [extensions.json](./.vscode/extensions.json)
- [settings.json](./.vscode/settings.json)
- [images](./images)
- [markdown-to-docx.jpg](./images/markdown-to-docx.jpg)
- [markdown-to-html.jpg](./images/markdown-to-html.jpg)
- [markdown-to-pdf.jpg](./images/markdown-to-pdf.jpg)
- [mdEditor.gif](./images/mdEditor.gif)
- [CHANGELOG.md](./CHANGELOG.md)
- [LICENSE](./LICENSE)
- [md](./md)
- [test.txt](./md/test.txt)
- [mdEditor.code-workspace](./mdEditor.code-workspace)
- [styles](./styles)
- [style.css](./styles/style.css)
- [rules.md](./styles/rules.md)
- [README.md](./README.md)

If the file structure matches, installation is complete. Well done!

> **NOTE: If using Linux you must uncomment the `pandoc.htmlOptString` in the `mdEditor.code-workspace` file. The current version, which uses Windows OS file separators, must be replaced with the Linux version; otherwise, the css styles will not be applied correctly.**
## Usage <a name = "usage"></a>

Expand All @@ -113,7 +119,13 @@ To test the filetype output, enter the key combination `CTRL + K`, then press `P

Workspace setup is now complete and mdEditor is ready to use.

>NOTE: The `syntax.md` file in the `styles` folder contains a detailed description of the linting rules available within the editor workspace. Most linting rules can be simply toggled on/off by editing the `.markdownlint.json` file using this syntax. `MDXXX : bool`
>NOTE: The `syntax.md` file in the `styles` folder contains a detailed description of the linting rules available within the editor workspace. Most linting rules can be simply toggled on/off by editing the `.markdownlint.json` file using this syntax.
```json
{
"MD-XXX": Boolean
}
```

Happy markdown'ing! :)

Expand Down
10 changes: 9 additions & 1 deletion mdEditor.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,25 @@
// NOTE: Other valid values are pdflatex, lualatex, xelatex, latexmk, tectonic, wkhtmltopdf, weasyprint, prince, context, and pdfroff.
"markdown.updateLinksOnFileMove.enabled": "prompt",
"markdown.validate.enabled": false,

//-------- Pandoc Option Configuration --------

// pandoc .docx output option template --
// No additional configuration necessary unless so desired.

"pandoc.docxOptString": "",

// pandoc .html output option template --
// On Linux, be sure to substitute this version of `htmlOptString` to avoid errors: "pandoc.htmlOptString": "-s -f gfm -t html5 --css=/styles/style.css",

"pandoc.htmlOptString": "-s -f gfm -t html5 --css=\\styles\\style.css",

// pandoc .pdf output option template --
// On Linux, be sure to substitute this version of `pdfOptString` to avoid errors:
//"pandoc.pdfOptString": "-s -f gfm -t pdf",
"pandoc.pdfOptString": "-s -f gfm -t latex"

"pandoc.pdfOptString": "-s -f gfm -t latex",
// NOTE: Other valid values are pdflatex, lualatex, xelatex, latexmk, tectonic, wkhtmltopdf, weasyprint, prince, context, and pdfroff.

}
}

0 comments on commit f1ab91a

Please sign in to comment.