From f8aafd63b91e6020c3211a3d38145917a83ee93e Mon Sep 17 00:00:00 2001 From: Eugene Sviridov <46542370+esvyridov@users.noreply.github.com> Date: Tue, 2 Jan 2024 15:14:34 +0100 Subject: [PATCH] remove mentions of the site folder in doc and config files (#1769) --- .eslintrc.js | 2 +- .npmignore | 1 - CONTRIBUTING.md | 13 ++++++------- scripts/generateChangelog.mjs | 2 +- 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index 56898e032..049c95d76 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -37,7 +37,7 @@ module.exports = { }, parserOptions: { tsconfigRootDir: __dirname, - project: ['./site/tsconfig.json', './packages/*/tsconfig.json'], + project: ['./docs/tsconfig.json', './packages/*/tsconfig.json'], ecmaVersion: 'latest', sourceType: 'module', }, diff --git a/.npmignore b/.npmignore index 718d7e342..f2e2f7010 100644 --- a/.npmignore +++ b/.npmignore @@ -4,7 +4,6 @@ stats node_modules tests scripts -site src build babel.config.js diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7200a3b5c..c85df7158 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,16 +144,19 @@ Root directories ```sh lucide -| ├── docs +│ ├── guide ├── icons ├── packages -├── scripts -└── site +└── scripts ``` ### Docs +The lucide.dev website is using [vitepress](https://vitepress.dev/) to generate the static website. The markdown files are located in the docs directory. + +### Guides + Detailed documentation about: installation, guides, packages, design guides etc. ### Icons @@ -170,10 +173,6 @@ Includes all the (npm) packages of lucide. Includes usefully scripts to automate certain jobs. Big part of the scripts is the template generation, for example it generates icon components for all the packages. These scripts are usually executed from the "scripts" section in the package.json. -### site - -The lucide.dev website is using [vitepress](https://vitepress.dev/) to generate the static website. The markdown files are located in the docs directory. - ## Documentation The documentation files are located in the [docs](https://github.com/lucide-icons/lucide/tree/main/docs) directory. All these markdown files will be loaded in the build of the lucide.dev website. diff --git a/scripts/generateChangelog.mjs b/scripts/generateChangelog.mjs index 597cb67f6..38ab0841a 100644 --- a/scripts/generateChangelog.mjs +++ b/scripts/generateChangelog.mjs @@ -47,7 +47,7 @@ const cliArguments = getArgumentOptions(process.argv.slice(2)); } const changedFiles = output.files.filter( - ({ filename }) => !filename.match(/site\/(.*)|(.*)package\.json|tags.json/g), + ({ filename }) => !filename.match(/docs\/(.*)|(.*)package\.json|tags.json/g), ); const commits = await Promise.all(changedFiles.map(fetchCommits));