Skip to content

Commit

Permalink
Merge pull request #9 from killshot13/development
Browse files Browse the repository at this point in the history
Development branch merging with main to integrate new updates
  • Loading branch information
killshot13 authored Jun 28, 2021
2 parents 95fbc53 + 5898c7c commit efad525
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 18 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@

# .code-workspace files provide localized, granular control over the mdEditor config
'./mdEditor.code-workspace'

# local files cached by the .devcontainer.
.dccache
1 change: 1 addition & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"default": true,
"MD003": { "style": "atx" },
"MD007": false,
"MD033": false,
"MD046": false,
Expand Down
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["davidanson.vscode-markdownlint", "DougFinke.vscode-pandoc"]
}
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
>
> **v3.1.0**

## Table of Contents

- [About](#about)
Expand Down Expand Up @@ -48,49 +47,53 @@ mdEditor is an adaptation derived from the brainchild of [Dave Johnson](https://

## Prerequisites <a name = "prerequisites"></a>

#### [Visual Studio Code](https://code.visualstudio.com/Download)

**[Visual Studio Code](https://code.visualstudio.com/Download)**
This should be self-explanantory.

#### [Pandoc](http://pandoc.org/installing.html)

**[Pandoc](http://pandoc.org/installing.html)**
This may require some guidance if you don't currently use Pandoc. I wrote a gist to help first-time users; here is [the link](https://gist.github.com/killshot13/5b379355d275e79a5cb1f03c841c7d53).

### Installation <a name = "installation"></a>

Decide where the core mdEditor files should live on your local drive (reference [About](#about) for more), then clone [mdEditor](https://github.com/killshot13/mdEditor.git) to that location.

Now, open mdEditor at the base directory using VSCode. Your IDE will auto-discover the `.code-workspace` file and prompt you to reopen the folder as a workspace. Confirm this choice, unless you wish to use a different configuration.

If so, there is a blank `settings.json` in the `.vscode` folder for you. Otherwise, you should disregard said folder completely.

We still need to pass the linting rulebook and Pandoc style guide to the editor workspace.

Let's install these VSCode extensions, leaving the settings at their default values.
You should have noticed a prompt once you entered the workspace about installing the recommended extensions. If you have not done so already, go ahead and approve the install.

If for some reason you did not receive a prompt or have already closed the notification tab, not to worry. Just install these VSCode extensions, leaving the settings at their default values.

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

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

Now, open mdEditor at the base directory using VSCode. Your IDE will auto-discover the `.code-workspace` file and prompt you to reopen the folder as a workspace. Confirm this choice, unless you wish to use a different configuration.

If so, there is a blank `settings.json` in the `.vscode` folder for you. Otherwise, you should disregard said folder completely.

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

**Tree View**
_mdEditor_
\+---.vscode
\+---.github-templates (+6)
|
+---.vscode
| `settings.json`
| `extensions.json`
|
+---images
| `mdEditor.gif` (+3)
|
+---md
| `project1.md`
| `project2.md`
| `test.txt`
|
+---styles
| `style.css`
| `syntax.md`
|
|`.markdownlint.json`
|`mdEditor.code-workspace`
|`README.md`
|`LICENSE`
|`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.**
Expand Down
5 changes: 3 additions & 2 deletions mdEditor.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@
"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 latex",
// 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 pdf",
"pandoc.pdfOptString": "-s -f gfm -t latex",
// NOTE: Other valid values are pdflatex, lualatex, xelatex, latexmk, tectonic, wkhtmltopdf, weasyprint, prince, context, and pdfroff.

"editor.semanticTokenColorCustomizations": {},
Expand Down

0 comments on commit efad525

Please sign in to comment.