@lauravivan/notion-portfolio 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/License +21 -0
  2. package/README.md +57 -0
  3. package/bin/cli.js +42 -0
  4. package/package.json +97 -0
package/License ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Laura Vivan Gonçalves
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # notion-portfolio
2
+
3
+ ## Description
4
+
5
+ Notion Portfolio was born based on Nitin Ranganath‘s VsCode Portfolio idea. You can create dynamic pages based on your needs, with a pallet of Notion components available.
6
+
7
+ ## Features
8
+
9
+ - Themes and customizations
10
+ - Light themes
11
+ - [x] Light theme (default)
12
+ - [x] Catpuccin Latte
13
+ - Dark themes
14
+ - [x] Dark theme (default)
15
+ - [x] Catpuccin Mocha
16
+ - Font styles
17
+ - [x] Roboto default
18
+ - [x] Roboto serif
19
+ - [x] Roboto mono
20
+ - Font sizes
21
+ - [x] Default size
22
+ - [x] Small text
23
+ - Page width
24
+ - [x] Full width
25
+ - [x] Centralized
26
+ - [x] Tabs for navigation (as in Notion Desktop)
27
+ - [ ] Search
28
+
29
+ ## Tools
30
+
31
+ ![Vue.js Badge](https://img.shields.io/badge/Vue.js-4FC08D?logo=vuedotjs&logoColor=fff&style=for-the-badge)
32
+ ![Sass Badge](https://img.shields.io/badge/Sass-C69?logo=sass&logoColor=fff&style=for-the-badge)
33
+ ![HTML5 Badge](https://img.shields.io/badge/HTML5-E34F26?logo=html5&logoColor=fff&style=for-the-badge)
34
+ ![Vite Badge](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=fff&style=for-the-badge)
35
+ ![JavaScript Badge](https://img.shields.io/badge/JavaScript-F7DF1E?logo=javascript&logoColor=000&style=for-the-badge)
36
+
37
+ ## Project Setup
38
+
39
+ ```sh
40
+ npm install
41
+ ```
42
+
43
+ ### Compile and Hot-Reload for Development
44
+
45
+ ```sh
46
+ npm run dev
47
+ ```
48
+
49
+ ### Compile and Minify for Production
50
+
51
+ ```sh
52
+ npm run build
53
+ ```
54
+
55
+ ## License
56
+
57
+ [MIT](https://choosealicense.com/licenses/mit/)
package/bin/cli.js ADDED
@@ -0,0 +1,42 @@
1
+ #!/usr/bin/env node
2
+ import fs from "fs";
3
+ import path from "path";
4
+ import { fileURLToPath } from "url";
5
+ import { execSync } from "child_process";
6
+ import chalk from 'chalk'
7
+ import 'dotenv/config'
8
+
9
+ const __filename = fileURLToPath(import.meta.url);
10
+ const __dirname = path.dirname(__filename);
11
+
12
+ const projectName = process.argv[2] || "my-portfolio";
13
+
14
+ const templateDir = path.resolve(__dirname, "../template");
15
+ const targetDir = path.resolve(process.cwd(), projectName);
16
+
17
+ const env = process.env.NODE_ENV;
18
+
19
+ if (fs.existsSync(targetDir)) {
20
+ console.error(`❌ Folder "${projectName}" already exists.`);
21
+ process.exit(1);
22
+ }
23
+
24
+ fs.cpSync(templateDir, targetDir, { recursive: true });
25
+ console.log(chalk.bgWhite(`✅ Project created in ./${projectName}`));
26
+
27
+ console.log(chalk.bgWhite("📦 Installing dependencies..."));
28
+ execSync(`npm install`, {
29
+ cwd: targetDir,
30
+ stdio: "inherit",
31
+ });
32
+
33
+ const installer = `npm ${env === 'development' ? 'link' : 'install'} @lauravivan/notion-portfolio`;
34
+
35
+ execSync(installer, {
36
+ cwd: targetDir,
37
+ stdio: "inherit",
38
+ });
39
+
40
+ console.log(chalk.yellow("🚀 All ready! Run commands below:"));
41
+ console.log(chalk.yellow(`\n cd ${projectName}`));
42
+ console.log(chalk.yellow(" npm run dev\n"));
package/package.json ADDED
@@ -0,0 +1,97 @@
1
+ {
2
+ "name": "@lauravivan/notion-portfolio",
3
+ "version": "1.0.1",
4
+ "description": "A Notion-based portfolio",
5
+ "type": "module",
6
+ "main": "./dist/index.es.js",
7
+ "module": "./dist/index.es.js",
8
+ "types": "./dist/index.d.ts",
9
+ "publishConfig": {
10
+ "access": "public"
11
+ },
12
+ "keywords": [
13
+ "notion",
14
+ "portfolio",
15
+ "cms"
16
+ ],
17
+ "author": "Laura Vivan",
18
+ "bin": {
19
+ "create-notion-portfolio": "bin/cli.js"
20
+ },
21
+ "scripts": {
22
+ "dev": "vite",
23
+ "build": "vue-tsc -b && vite build",
24
+ "build:pkg": "vue-tsc -b && vite build --config vite.config.package.ts",
25
+ "preview": "vite preview",
26
+ "sass": "sass src/assets/scss/main.scss:src/assets/css/main.css",
27
+ "watch-sass": "sass @core/assets/scss/main.scss:@core/assets/css/main.css --watch",
28
+ "test:cli": "node ./bin/cli.js",
29
+ "format": "npx prettier --write .",
30
+ "lint": "npx eslint .",
31
+ "lint:fix": "npx eslint . --fix",
32
+ "prepare": "husky",
33
+ "lint:css": "stylelint '**/*.css'",
34
+ "lint:css:fix": "stylelint '**/*.css' --fix"
35
+ },
36
+ "repository": {
37
+ "type": "git",
38
+ "url": "git+https://github.com/lauravivan/notion-portfolio.git"
39
+ },
40
+ "bugs": {
41
+ "url": "https://github.com/lauravivan/notion-portfolio/issues"
42
+ },
43
+ "homepage": "https://github.com/lauravivan/notion-portfolio#readme",
44
+ "files": [
45
+ "dist",
46
+ "bin",
47
+ "README.md",
48
+ "License"
49
+ ],
50
+ "engines": {
51
+ "node": ">=14"
52
+ },
53
+ "lint-staged": {
54
+ "*.{js,jsx,ts,tsx,vue}": [
55
+ "eslint --fix",
56
+ "prettier --write"
57
+ ]
58
+ },
59
+ "devDependencies": {
60
+ "@eslint/js": "^9.39.2",
61
+ "@eslint/json": "^0.14.0",
62
+ "@iconify/vue": "^5.0.0",
63
+ "@semantic-release/changelog": "^6.0.3",
64
+ "@semantic-release/git": "^10.0.1",
65
+ "@types/node": "^25.0.3",
66
+ "@vitejs/plugin-vue": "^6.0.3",
67
+ "@vue/tsconfig": "^0.8.1",
68
+ "eslint": "^9.39.2",
69
+ "eslint-config-prettier": "^10.1.8",
70
+ "eslint-plugin-vue": "^10.6.2",
71
+ "globals": "^16.5.0",
72
+ "husky": "^9.1.7",
73
+ "jiti": "^2.6.1",
74
+ "lint-staged": "^16.2.7",
75
+ "mitt": "^3.0.1",
76
+ "prettier": "3.7.4",
77
+ "sass": "^1.97.1",
78
+ "semantic-release": "^25.0.2",
79
+ "stylelint": "^16.26.1",
80
+ "stylelint-config-standard": "^39.0.1",
81
+ "typescript": "^5.9.3",
82
+ "typescript-eslint": "^8.50.1",
83
+ "vite": "^7.3.0",
84
+ "vite-plugin-dts": "^4.5.4",
85
+ "vue-eslint-parser": "^10.2.0",
86
+ "vue-tsc": "^3.2.1"
87
+ },
88
+ "dependencies": {
89
+ "@vueuse/core": "^14.1.0",
90
+ "chalk": "^5.6.2",
91
+ "dotenv": "^17.2.3",
92
+ "flatted": "^3.3.3",
93
+ "pinia": "^3.0.4",
94
+ "vue": "^3.5.26",
95
+ "vue-router": "^4.6.4"
96
+ }
97
+ }