diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md index 970c9be69f..365cd05304 100644 --- a/docs/userGuide/gettingStarted.md +++ b/docs/userGuide/gettingStarted.md @@ -41,7 +41,7 @@ Usage: ... ++**2. Initialize a new Project (or Start with an existing Project)**++ + Navigate into an empty directory and run the following command to initialize a skeletal MarkBind site in that directory. It will create several new files in the directory e.g., `index.md`, `site.json`. @@ -62,7 +62,7 @@ The `init` command populates the project with the [default project template](htt + Navigate to the project {{ tooltip_root_directory }}. diff --git a/docs/userGuide/siteJsonFile.md b/docs/userGuide/siteJsonFile.md index 5be59ec10c..c7bf3bf35a 100644 --- a/docs/userGuide/siteJsonFile.md +++ b/docs/userGuide/siteJsonFile.md @@ -43,7 +43,7 @@ Here is a typical `site.json` file: "layout": "subtopic" } ], - "pagesExclude": ["subsite/**/*.md"], + "pagesExclude": ["subsite/**/*.md", "node_modules/*"], "externalScripts": [ "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML" ], @@ -59,7 +59,8 @@ Here is a typical `site.json` file: "_site/*", "*.json", "*.md", - ".git/*" + ".git/*", + "node_modules/*" ], "plugins" : [ "filterTags" diff --git a/packages/core/template/default/site.json b/packages/core/template/default/site.json index 42cfed9ef7..d4a41e9898 100755 --- a/packages/core/template/default/site.json +++ b/packages/core/template/default/site.json @@ -8,8 +8,10 @@ "site.json", "*.md", "*.njk", - ".git/*" + ".git/*", + "node_modules/*" ], + "pagesExclude": ["node_modules/*"], "pages": [ { "src": "index.md", diff --git a/packages/core/template/minimal/site.json b/packages/core/template/minimal/site.json index d77b3adcf1..659551c65e 100644 --- a/packages/core/template/minimal/site.json +++ b/packages/core/template/minimal/site.json @@ -1,25 +1,27 @@ { - "baseUrl": "", - "titlePrefix": "", - "ignore": [ - "_markbind/layouts/*", - "_markbind/logs/*", - "_site/*", - "site.json", - "*.md", - "*.njk", - ".git/*" - ], - "pages": [ - { - "src": "index.md", - "title": "Hello World" - }, - { - "glob": ["**/index.md", "**/*.md"] - } - ], - "deploy": { - "message": "Site Update." + "baseUrl": "", + "titlePrefix": "", + "ignore": [ + "_markbind/layouts/*", + "_markbind/logs/*", + "_site/*", + "site.json", + "*.md", + "*.njk", + ".git/*", + "node_modules/*" + ], + "pagesExclude": ["node_modules/*"], + "pages": [ + { + "src": "index.md", + "title": "Hello World" + }, + { + "glob": ["**/index.md", "**/*.md"] } + ], + "deploy": { + "message": "Site Update." + } } diff --git a/packages/core/test/unit/utils/data.js b/packages/core/test/unit/utils/data.js index 52133ae8cf..b6d9ffde98 100644 --- a/packages/core/test/unit/utils/data.js +++ b/packages/core/test/unit/utils/data.js @@ -54,8 +54,10 @@ module.exports.SITE_JSON_DEFAULT = '{\n' + ' "site.json",\n' + ' "*.md",\n' + ' "*.njk",\n' - + ' ".git/*"\n' + + ' ".git/*",\n' + + ' "node_modules/*"\n' + ' ],\n' + + ' "pagesExclude": ["node_modules/*"],\n' + ' "pages": [\n' + ' {\n' + ' "src": "index.md",\n'