├── .github
└── workflows
│ ├── deploy-tests.yml
│ └── publish-npm.yml
├── .gitignore
├── .vscode
└── settings.json
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── src
├── index.css
└── index.js
├── test
├── alpinejs.html
├── index.html
└── vuejs.html
└── vite.config.js
/.github/workflows/deploy-tests.yml:
--------------------------------------------------------------------------------
1 | name: Deploy tests
2 | on:
3 | release:
4 | types: published
5 | workflow_dispatch:
6 | concurrency:
7 | group: ${{ github.workflow }}
8 | cancel-in-progress: true
9 | jobs:
10 | deploy-tests:
11 | permissions:
12 | contents: read
13 | id-token: write
14 | pages: write
15 | deployments: write
16 | environment:
17 | name: github-pages
18 | url: ${{ steps.deploy-pages.outputs.page_url }}
19 | runs-on: ubuntu-latest
20 | steps:
21 | - uses: actions/checkout@v3
22 | - uses: actions/setup-node@v3
23 | with:
24 | cache: npm
25 | - run: npm ci
26 | - id: configure-pages
27 | uses: actions/configure-pages@v3
28 | - run: npm run build
29 | env:
30 | BASE_URL: ${{ steps.configure-pages.outputs.base_url }}/
31 | - uses: actions/upload-pages-artifact@v1
32 | with:
33 | path: test
34 | - id: deploy-pages
35 | uses: actions/deploy-pages@v2
36 |
--------------------------------------------------------------------------------
/.github/workflows/publish-npm.yml:
--------------------------------------------------------------------------------
1 | name: Publish npm
2 | on:
3 | release:
4 | types: published
5 | workflow_dispatch:
6 | concurrency:
7 | group: ${{ github.workflow }}
8 | cancel-in-progress: true
9 | jobs:
10 | publish-npm:
11 | runs-on: ubuntu-latest
12 | steps:
13 | - uses: actions/checkout@v3
14 | - uses: actions/setup-node@v3
15 | with:
16 | cache: npm
17 | registry-url: https://registry.npmjs.org/
18 | - run: npm ci
19 | - run: npm run build
20 | - run: npm publish
21 | env:
22 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
23 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # This is easier than trying to mess with a testing server.
2 | ezmdpage.min.js
3 |
4 | #region https://github.com/github/gitignore/blob/main/Node.gitignore
5 | # Logs
6 | logs
7 | *.log
8 | npm-debug.log*
9 | yarn-debug.log*
10 | yarn-error.log*
11 | lerna-debug.log*
12 | .pnpm-debug.log*
13 |
14 | # Diagnostic reports (https://nodejs.org/api/report.html)
15 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
16 |
17 | # Runtime data
18 | pids
19 | *.pid
20 | *.seed
21 | *.pid.lock
22 |
23 | # Directory for instrumented libs generated by jscoverage/JSCover
24 | lib-cov
25 |
26 | # Coverage directory used by tools like istanbul
27 | coverage
28 | *.lcov
29 |
30 | # nyc test coverage
31 | .nyc_output
32 |
33 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
34 | .grunt
35 |
36 | # Bower dependency directory (https://bower.io/)
37 | bower_components
38 |
39 | # node-waf configuration
40 | .lock-wscript
41 |
42 | # Compiled binary addons (https://nodejs.org/api/addons.html)
43 | build/Release
44 |
45 | # Dependency directories
46 | node_modules/
47 | jspm_packages/
48 |
49 | # Snowpack dependency directory (https://snowpack.dev/)
50 | web_modules/
51 |
52 | # TypeScript cache
53 | *.tsbuildinfo
54 |
55 | # Optional npm cache directory
56 | .npm
57 |
58 | # Optional eslint cache
59 | .eslintcache
60 |
61 | # Optional stylelint cache
62 | .stylelintcache
63 |
64 | # Microbundle cache
65 | .rpt2_cache/
66 | .rts2_cache_cjs/
67 | .rts2_cache_es/
68 | .rts2_cache_umd/
69 |
70 | # Optional REPL history
71 | .node_repl_history
72 |
73 | # Output of 'npm pack'
74 | *.tgz
75 |
76 | # Yarn Integrity file
77 | .yarn-integrity
78 |
79 | # dotenv environment variable files
80 | .env
81 | .env.development.local
82 | .env.test.local
83 | .env.production.local
84 | .env.local
85 |
86 | # parcel-bundler cache (https://parceljs.org/)
87 | .cache
88 | .parcel-cache
89 |
90 | # Next.js build output
91 | .next
92 | out
93 |
94 | # Nuxt.js build / generate output
95 | .nuxt
96 | dist
97 |
98 | # Gatsby files
99 | .cache/
100 | # Comment in the public line in if your project uses Gatsby and not Next.js
101 | # https://nextjs.org/blog/next-9-1#public-directory-support
102 | # public
103 |
104 | # vuepress build output
105 | .vuepress/dist
106 |
107 | # vuepress v2.x temp and cache directory
108 | .temp
109 | .cache
110 |
111 | # Docusaurus cache and generated files
112 | .docusaurus
113 |
114 | # Serverless directories
115 | .serverless/
116 |
117 | # FuseBox cache
118 | .fusebox/
119 |
120 | # DynamoDB Local files
121 | .dynamodb/
122 |
123 | # TernJS port file
124 | .tern-port
125 |
126 | # Stores VSCode versions used for testing VSCode extensions
127 | .vscode-test
128 |
129 | # yarn v2
130 | .yarn/cache
131 | .yarn/unplugged
132 | .yarn/build-state.yml
133 | .yarn/install-state.gz
134 | .pnp.*
135 | #endregion
136 |
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "files.associations": {
3 | "*.html": "markdown"
4 | }
5 | }
6 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 TogaJam
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.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Easy self-rendering Markdown pages
2 |
3 | 📝 Write raw Markdown in `.html` files that gets auto-rendered everywhere \
4 | 💡 Inspired by [markdeep]
5 |
6 |
7 |
8 | 
9 |
10 |
11 | [Test page](https://jcbhmr.me/ezmdpage/)
12 | | [ezmdpage & Alpine.js](https://jcbhmr.me/ezmdpage/alpinejs.html)
13 | | [ezmdpage & Vue.js](https://jcbhmr.me/ezmdpage/vuejs.html)
14 |
15 |
16 |
17 | 📂 Works with `file:///document.html` documents \
18 | 📜 Failsafe text fallback when JavaScript is disabled \
19 | 🎨 Styled using GitHub's Markdown CSS \
20 | 🏝️ Works offline!
21 |
22 | ## Installation
23 |
24 | 
25 | 
26 |
27 | You can Ctrl+S [the `ezmdpage.min.js` file] to
28 | download it and load it locally (for offline use) or use an npm CDN like
29 | [unpkg.com] or [jsDelivr] to load it from the web:
30 |
31 |
32 | ```html
33 |
34 |
35 |
36 | ```
37 |
38 | 💡 You may also configure your formatter & editor
39 |
40 | To get the best editing experience, you can configure Prettier or your other
41 | favorite formatter to use its Markdown parser/beautifier on `.html` files.
42 |
43 | ```jsonc
44 | // package.json
45 | {
46 | "prettier": {
47 | "overrides": [
48 | {
49 | "files": ["*.html"],
50 | "options": {
51 | "parser": "markdown"
52 | }
53 | }
54 | ]
55 | }
56 | }
57 | ```
58 |
59 | 💡 You can also use a custom suffix like `.md.html` or something if you have
60 | other non-ezmdpage HTML content in your workspace too.
61 |
62 | ⚛️ To get proper syntax highlighting in VS Code, you'll need to configure it to
63 | use its Markdown mode for `.html` files. You can do this by adding this to your
64 | `.vscode/settings.json` file:
65 |
66 | ```jsonc
67 | {
68 | "files.associations": {
69 | "*.html": "markdown"
70 | }
71 | }
72 | ```
73 |
74 |