Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

escape tag for url special character #8

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist/*
test/*
59 changes: 54 additions & 5 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,35 @@
"es6": true,
"node": true
},
"extends": "eslint:recommended",
"parser": "@typescript-eslint/parser",
"plugins": [
"@typescript-eslint"
],
"extends": [
"plugin:@typescript-eslint/recommended"
],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parserOptions": {
"ecmaVersion": 2018
"ecmaVersion": 2018,
"sourceType": "module"
},
"rules": {
"camelcase": "off",
"@typescript-eslint/camelcase": [
"off"
],
"indent": [
"error",
"warn",
2,
{
"SwitchCase": 1
}
],
"@typescript-eslint/indent": [
"warn",
2,
{
"SwitchCase": 1
Expand All @@ -33,6 +51,37 @@
"error",
"never"
],
"no-console": "off"
}
"no-console": "off",
"@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/no-use-before-define": [
"error",
{
"functions": false,
"classes": true
}
],
"@typescript-eslint/member-delimiter-style": [
"error",
{
"multiline": {
"delimiter": "none",
"requireLast": false
},
"singleline": {
"delimiter": "semi",
"requireLast": false
}
}
]
},
"overrides": [
{
"files": [
"*.js"
],
"rules": {
"@typescript-eslint/no-var-requires": "off"
}
}
]
}
14 changes: 0 additions & 14 deletions .vscode/launch.json

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019-present Wen-Zhi Wang
Copyright (c) 2019-present Wen-Zhi Wang <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# notablog
# Notablog

![version](https://img.shields.io/npm/v/notablog.svg?style=flat-square&color=007acc&label=version) ![license](https://img.shields.io/github/license/dragonman225/notablog.svg?style=flat-square&label=license&color=08CE5D)

Generate a minimalistic blog from a Notion.so table.

Here are some images of [my blog](https://dragonman225.js.org/), using [`notablog-starter`'s default theme](https://github.com/dragonman225/notablog-starter/tree/master/themes/pure). 🙂
Below are some screenshots of [my blog](https://dragonman225.js.org/). 🙂

| Mobile | Desktop |
| :---------------------------: | :----------------------------: |
Expand Down Expand Up @@ -55,22 +55,28 @@ Here are some images of [my blog](https://dragonman225.js.org/), using [`notablo
notablog generate .
```

7. After it finishes, go to `notablog-starter/public/` directory, open `index.html` with a browser to preview your site. Or, you can change `previewBrowser` field in `config.json` to the path of a browser you use and run command:
7. After it finishes, go to `notablog-starter/public/` directory, open `index.html` with a browser to preview your site.

* Optionally, you could change the `previewBrowser` field in `config.json` to the path of a browser executable you have on your computer and issue the following command anywhere to preview.

```bash
notablog preview .
notablog preview <path_to_the_notablog-starter>
```

### Your site is ready now!
### Congratulations! Your website is ready now!

* You can copy files in `notablog-starter/public/` directory to a server or upload them to any static hosting service to share your content with the world.

* You can copy files in `notablog-starter/public/` directory to your server or upload them to any static hosting service to share your content with the world.
* Whenever you want to update your site, go into `notablog-starter/` directory and issue command `notablog generate .`, or issue the command from outside `notablog-starter/` with the pattern `notablog generate <path_to_the_notablog-starter>`.

* Some options for static hosting services:

* [Github Pages](https://pages.github.com/)
* [Netlify](https://www.netlify.com/)
* [surge.sh](https://surge.sh)

* Some options for self-hosting:

* [nginx](https://www.nginx.com/)
* [lighttpd](https://www.lighttpd.net/)
* [Apache httpd](https://httpd.apache.org/)
Expand Down Expand Up @@ -211,6 +217,10 @@ Generated by `dependency-cruiser` NPM package.

![](assets/deps_graph.svg)

### EJS
### Project Status

See https://dragonman225.js.org/notablog-stat.html

### Git

There is an experimental version at `ejs` branch that uses [EJS](https://ejs.co/) as template engine. Main advantage of EJS is its `include` feature, which enable us to make repetitive parts of template into components that can be reused. I also made an EJS version of `notablog-theme-pure` [here](https://github.com/dragonman225/notablog-theme-pure-ejs).
`master` is the working branch, latest release is `v0.4.1`, which is at branch `v0.4.1`.
Loading