Skip to content

Commit de2a462

Browse files
hkennyvhkennyv
committed
update README and add LICENSE
1 parent 6b7eb39 commit de2a462

File tree

2 files changed

+142
-1
lines changed

2 files changed

+142
-1
lines changed

Diff for: ‎LICENSE

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2020 panr and hkennyv
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Diff for: ‎README.md

+133-1
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,144 @@
22

33
# next-theme-terminal
44

5-
This repository is a NextJS port of [hugo-theme-terminal](https://github.com/panr/hugo-theme-terminal).
5+
This repository is a NextJS port of the popular hugo theme, [hugo-theme-terminal](https://github.com/panr/hugo-theme-terminal).
6+
7+
It uses [Next.js](https://nextjs.org/) v9.5.3 and was bootstrapped using
8+
[`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
9+
It also includes one-click instructions on how to [deploy to netlify](#how-to-start).
10+
11+
This port is still under development and has not reached feature parity
12+
with the original theme yet. See the [TODO](#todo) section for more
13+
information on the available features.
614

715
### DEMO - https://hopeful-minsky-25f7e0.netlify.app/
816

917
---
1018

19+
## Features
20+
21+
- **5 duotone themes**, depending on your preferences (orange is default, red, blue, green, pink)
22+
- [**Fira Code**](https://github.com/tonsky/FiraCode) as default monospaced font. It's gorgeous!
23+
- **really nice duotone**, custom syntax highlighting based on [**PrismJS**](https://prismjs.com)
24+
- fully responsive
25+
26+
#### Code highlighting (TODO)
27+
28+
A custom syntax highlighting based on PrismJS. All you need to do is to wrap you code like this:
29+
30+
````
31+
```html
32+
// your code here
33+
````
34+
35+
**Supported languages**: bash/shell, css, clike, javascript, apacheconf, actionscript, applescript, c, csharp, cpp, coffeescript, ruby, csp, css-extras, diff, django, docker, elixir, elm, markup-templating, erlang, fsharp, flow, git, go, graphql, less, handlebars, haskell, http, java, json, kotlin, latex, markdown, makefile, objectivec, ocaml, perl, php, php-extras, r, sql, processing, scss, python, jsx, typescript, toml, reason, textile, rust, sass, stylus, scheme, pug, swift, yaml, haml, twig, tsx, vim, visual-basic, wasm.
36+
37+
## How to start
38+
39+
**Option one:** One-click deploy
40+
41+
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/hkennyv/next-theme-terminal)
42+
43+
(If you click this button, it will create a new repo for you that looks
44+
exactly like this one, and sets that repo up immediately for deployment
45+
on Netlify)
46+
47+
**Option two:** Manual clone
48+
49+
1. Clone this repo: `git clone [email protected]:hkennyv/next-theme-terminal.git`
50+
2. Change directories into the repository: `cd next-theme-terminal`
51+
3. Install the dependencies and run the development server: `yarn install && yarn dev`
52+
4. View the site at: <http://localhost:3000>
53+
54+
## How to configure (TODO)
55+
56+
To configure the site, edit the `siteconfig.json` file. This allows you to
57+
customize the site at build time without having to modify any code at all.
58+
59+
Here is a complete sample file:
60+
61+
```json
62+
{
63+
"TODO": "copy final siteconfig.json here when done"
64+
}
65+
```
66+
67+
## Post front-matter
68+
69+
This project uses [gray-matter](https://github.com/jonschlinkert/gray-matter)
70+
to parse YAML front-matter from the markdown content. You should create your
71+
front-matter using the following structure:
72+
73+
```YAML
74+
---
75+
title: My post title
76+
date: 2020-09-28
77+
author: hkennyv
78+
authorTwitter: hkennyv
79+
cover: /images/uploads/hello.jpg
80+
tags:
81+
- me
82+
- life
83+
keywords:
84+
- blog
85+
- lifestyle
86+
description: A short description of the post!
87+
showFullContent: true
88+
---
89+
```
90+
91+
**\* note:** not all of these paramters are implemented yet, see the
92+
[TODO](#todo) section for a table of which ones are supported
93+
94+
## Add-ons
95+
96+
TODO
97+
98+
## How to (safely) edit the theme
99+
100+
TODO
101+
102+
## Found a bug?
103+
104+
If you spot any bugs, please use [Issue Tracker](https://github.com/hkennyv/next-theme-terminal/issues) or create a new [Pull Request](https://github.com/hkennyv/next-theme-terminal/pulls) to fix the issue.
105+
106+
## New cool idea or feature?
107+
108+
I'd like to keep this mostly in parity with the original hugo theme by
109+
[@panr](https://github.com/panr), so if you havea a feature you'd like to see,
110+
please follow the [instructions here](https://github.com/panr/hugo-theme-terminal#new-cool-idea-or-feature-)
111+
so we can get it into the original theme and this port will follow suit.
112+
113+
# License
114+
115+
Copyright © 2019-2020 Radosław Kozieł ([@panr](https://twitter.com/panr)) and Kenny Huynh ([@hkennyv](https://github.com/hkennyv)).
116+
117+
The theme is released under the MIT License. Check the [original theme license](https://github.com/hkennyv/next-theme-terminal/blob/master/LICENSE) for additional licensing information.
118+
119+
## TODO
120+
121+
Below is a list of features that have yet to be implemented in this port.
122+
I'll try to check them off as I go with the goal of eventually reaching
123+
parity with the original theme. Contributions welcome 😊
124+
125+
- [ ] finish filling out README
126+
- [ ] configuration parity of `siteconfig.json` with `config.toml`
127+
- [ ] front-matter support
128+
- [x] title
129+
- [x] date
130+
- [x] author
131+
- [ ] authorTwitter
132+
- [x] cover
133+
- [ ] tags
134+
- [ ] keywords
135+
- [x] description
136+
- [ ] showFullContent
137+
- [ ] add-ons (disqus comments, extended header, extended footer)
138+
- [ ] syntax highlighting for code
139+
- [ ] mobile responsiveness
140+
141+
---
142+
11143
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
12144

13145
## Getting Started

0 commit comments

Comments
 (0)