diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index c5698996..fe04e081 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -35,14 +35,12 @@ jobs: - name: Link package directories together if it's not already done as a part of install. if: steps.lerna-yarn-cache.outputs.cache-hit == 'true' run: yarn link - - name: Build packages to get cross-references working 🔧 + - name: Build packages 🔧 (docs included 📄) run: yarn build - - name: Build docs 📄 - run: yarn docs:build - name: Deploy 🚀 uses: JamesIves/github-pages-deploy-action@releases/v3 with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} BRANCH: gh-pages - FOLDER: docs/.vuepress/dist + FOLDER: packages/docs/.vuepress/dist CLEAN: true \ No newline at end of file diff --git a/.gitignore b/.gitignore index c2900fb8..53e6b064 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,4 @@ report.html .nyc_output .vscode dist -docs/.vuepress/public/packages coverage diff --git a/.releaserc b/.releaserc new file mode 100644 index 00000000..54ea104b --- /dev/null +++ b/.releaserc @@ -0,0 +1 @@ +"extends": "semantic-release-monorepo" diff --git a/package.json b/package.json index b13ed7e2..0608c594 100644 --- a/package.json +++ b/package.json @@ -8,25 +8,17 @@ "scripts": { "publish": "lerna publish", "start": "lerna run start --parallel", - "build": "lerna run build", + "build": "lerna run build --stream", "test": "lerna run test --parallel", "watch:test": "lerna run watch:test --parallel", "coverage": "lerna run coverage --parallel", "lint": "concurrently 'lerna run lint --parallel' 'yarn lint:text'", - "lint:text": "textlint docs/**/* README.md packages/*/README.md", + "lint:text": "textlint README.md packages/*/README.md", "fix:lint": "concurrently 'lerna run fix:lint --parallel' 'yarn lint:text --fix'", "link": "lerna link", "postinstall": "lerna bootstrap", "what-changed": "lerna changed", - "diff": "lerna diff", - "clean:docs:bundles": "rimraf docs/.vuepress/public/packages/*", - "predocs:dev": "yarn clean:docs:bundles", - "docs:dev": "concurrently yarn:docs:dev:*", - "docs:dev:vuepress": "vuepress dev docs", - "docs:dev:packages": "lerna run --parallel docs:dev", - "predocs:build": "yarn clean:docs:bundles", - "docs:build": "lerna run --stream docs:build", - "postdocs:build": "vuepress build docs" + "diff": "lerna diff" }, "keywords": [ "carousel", diff --git a/packages/core/package.json b/packages/core/package.json index 02b70d9e..9fcd8677 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -24,9 +24,7 @@ "watch:test": "concurrently yarn:watch:test:*", "watch:test:scripts:unit": "yarn test:scripts:unit --watch", "build": "microbundle", - "start": "microbundle watch", - "docs:dev": "microbundle watch -o ../../docs/.vuepress/public/packages/core.js --no-pkg-main -f umd", - "docs:build": "microbundle -o ../../docs/.vuepress/public/packages/core.js --no-pkg-main -f umd" + "start": "microbundle watch" }, "keywords": [ "carousel", diff --git a/docs/.vuepress/components/Footer.vue b/packages/docs/.vuepress/components/Footer.vue similarity index 100% rename from docs/.vuepress/components/Footer.vue rename to packages/docs/.vuepress/components/Footer.vue diff --git a/docs/.vuepress/components/HeroSection.vue b/packages/docs/.vuepress/components/HeroSection.vue similarity index 100% rename from docs/.vuepress/components/HeroSection.vue rename to packages/docs/.vuepress/components/HeroSection.vue diff --git a/docs/.vuepress/components/NavLink.vue b/packages/docs/.vuepress/components/NavLink.vue similarity index 100% rename from docs/.vuepress/components/NavLink.vue rename to packages/docs/.vuepress/components/NavLink.vue diff --git a/docs/.vuepress/config.js b/packages/docs/.vuepress/config.js similarity index 97% rename from docs/.vuepress/config.js rename to packages/docs/.vuepress/config.js index 05488f09..85eb6582 100644 --- a/docs/.vuepress/config.js +++ b/packages/docs/.vuepress/config.js @@ -18,7 +18,7 @@ module.exports = { ], searchPlaceholder: 'Search in docs...', repo: 'frsource/tiny-carousel', - docsDir: 'docs', + docsDir: 'packages/docs', editLinks: true, editLinkText: 'Help us improve this page on GitHub', smoothScroll: true, @@ -63,7 +63,7 @@ module.exports = { } function getSideBar() { - const ignoreDirs = ['.vuepress']; + const ignoreDirs = ['.vuepress', 'node_modules']; return fs .readdirSync(path.join(__dirname, '..'), { withFileTypes: true }) diff --git a/docs/.vuepress/mixins/scrollAnchorIntoView.js b/packages/docs/.vuepress/mixins/scrollAnchorIntoView.js similarity index 100% rename from docs/.vuepress/mixins/scrollAnchorIntoView.js rename to packages/docs/.vuepress/mixins/scrollAnchorIntoView.js diff --git a/docs/.vuepress/public/logo.jpg b/packages/docs/.vuepress/public/logo.jpg similarity index 100% rename from docs/.vuepress/public/logo.jpg rename to packages/docs/.vuepress/public/logo.jpg diff --git a/docs/.vuepress/public/logo.svg b/packages/docs/.vuepress/public/logo.svg similarity index 100% rename from docs/.vuepress/public/logo.svg rename to packages/docs/.vuepress/public/logo.svg diff --git a/docs/.vuepress/styles/index.styl b/packages/docs/.vuepress/styles/index.styl similarity index 100% rename from docs/.vuepress/styles/index.styl rename to packages/docs/.vuepress/styles/index.styl diff --git a/docs/.vuepress/styles/palette.styl b/packages/docs/.vuepress/styles/palette.styl similarity index 100% rename from docs/.vuepress/styles/palette.styl rename to packages/docs/.vuepress/styles/palette.styl diff --git a/docs/api-reference/README.md b/packages/docs/api-reference/README.md similarity index 100% rename from docs/api-reference/README.md rename to packages/docs/api-reference/README.md diff --git a/docs/contribution/README.md b/packages/docs/contribution/README.md similarity index 100% rename from docs/contribution/README.md rename to packages/docs/contribution/README.md diff --git a/docs/ecosystem/README.md b/packages/docs/ecosystem/README.md similarity index 100% rename from docs/ecosystem/README.md rename to packages/docs/ecosystem/README.md diff --git a/docs/example.src.html b/packages/docs/example.src.html similarity index 100% rename from docs/example.src.html rename to packages/docs/example.src.html diff --git a/docs/guide/README.md b/packages/docs/guide/README.md similarity index 100% rename from docs/guide/README.md rename to packages/docs/guide/README.md diff --git a/docs/guide/installation.md b/packages/docs/guide/installation.md similarity index 100% rename from docs/guide/installation.md rename to packages/docs/guide/installation.md diff --git a/docs/guide/usage.md b/packages/docs/guide/usage.md similarity index 100% rename from docs/guide/usage.md rename to packages/docs/guide/usage.md diff --git a/docs/index.md b/packages/docs/index.md similarity index 100% rename from docs/index.md rename to packages/docs/index.md diff --git a/packages/docs/package.json b/packages/docs/package.json new file mode 100644 index 00000000..dc64e070 --- /dev/null +++ b/packages/docs/package.json @@ -0,0 +1,45 @@ +{ + "name": "@frsource/tiny-carousel-docs", + "version": "0.0.0", + "description": "Documentation for @frsource/tiny-carousel 📄", + "main": ".vuepress/dist/index.html", + "scripts": { + "lint": "concurrently yarn:lint:*", + "lint:text": "textlint **/*.md", + "fix:lint": "concurrently 'yarn lint:scripts --fix' 'yarn lint:styles --fix' 'yarn lint:text --fix'", + "build": "vuepress build .", + "start": "vuepress dev ." + }, + "keywords": [ + "carousel", + "slider", + "swiper", + "tiny", + "documentation", + "docs", + "vuepress", + "efficient", + "modular", + "lightweight", + "mobile-friendly", + "css snap", + "scroll snap", + "snapping points" + ], + "author": "Jakub Freisler ", + "license": "MIT", + "bugs": { + "url": "https://github.com/FRSource/tiny-carousel/issues" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/FRSource/tiny-carousel.git" + }, + "homepage": "https://www.frsource.org/tiny-carousel/", + "dependencies": { + "@frsource/tiny-carousel-utils": "*", + "@frsource/tiny-carousel-core": "*", + "@frsource/tiny-carousel-plugin-custom-events": "*", + "@frsource/tiny-carousel-plugin-scroll-snap-fallback": "*" + } +} diff --git a/packages/plugin-custom-events/package.json b/packages/plugin-custom-events/package.json index 2997e9a1..00f7284e 100644 --- a/packages/plugin-custom-events/package.json +++ b/packages/plugin-custom-events/package.json @@ -20,9 +20,7 @@ "coverage:scripts": "yarn test:scripts:unit --coverage", "watch:test": "concurrently yarn:watch:test:*", "watch:test:scripts:unit": "yarn test:scripts:unit --watch", - "build": "microbundle", - "docs:dev": "microbundle watch -o ../../docs/.vuepress/public/packages/pluginCustomEvents.js --no-pkg-main -f umd", - "docs:build": "microbundle -o ../../docs/.vuepress/public/packages/pluginCustomEvents.js --no-pkg-main -f umd" + "build": "microbundle" }, "devDependencies": { "@frsource/tiny-carousel-core": "*" diff --git a/packages/plugin-scroll-snap-fallback/package.json b/packages/plugin-scroll-snap-fallback/package.json index c4839726..a398f6b7 100644 --- a/packages/plugin-scroll-snap-fallback/package.json +++ b/packages/plugin-scroll-snap-fallback/package.json @@ -21,9 +21,7 @@ "watch:test": "concurrently yarn:watch:test:*", "watch:test:scripts:unit": "yarn test:scripts:unit --watch", "build": "microbundle", - "start": "microbundle watch", - "docs:dev": "microbundle watch -o ../../docs/.vuepress/public/packages/pluginScrollSnapFallback.js --no-pkg-main -f umd", - "docs:build": "microbundle -o ../../docs/.vuepress/public/packages/pluginScrollSnapFallback.js --no-pkg-main -f umd" + "start": "microbundle watch" }, "keywords": [ "carousel", diff --git a/packages/utils/package.json b/packages/utils/package.json index a037de36..eb65f345 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -21,9 +21,7 @@ "watch:test": "concurrently yarn:watch:test:*", "watch:test:scripts:unit": "yarn test:scripts:unit --watch", "build": "microbundle", - "start": "microbundle watch", - "docs:dev": "microbundle watch -o ../../docs/.vuepress/public/packages/utils.js --no-pkg-main -f umd", - "docs:build": "microbundle -o ../../docs/.vuepress/public/packages/utils.js --no-pkg-main -f umd" + "start": "microbundle watch" }, "keywords": [ "carousel",