You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 14, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+8-15Lines changed: 8 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,28 +21,23 @@ if you're happy and you know it, star this repo
21
21
22
22
A dev blog starter for 2020.
23
23
24
-
- Works as a Markdown static-site generator out of the box
25
-
- Supports static exporting and hot reload (powered by Next.js)
24
+
- Works as a Markdown-based static-site generator out of the box: just add new blog posts to `/md/blog`
25
+
- Supports exporting to fully static assets (powered by Next.js)
26
+
- Hot reload (powered by Next.js)
26
27
- Makes it easy to write custom pages/code in React + TypeScript
27
-
- Support for code blocks with syntax highlighting
28
+
- Provides a `Markdown.tsx` component with support for GitHub-style syntax highlighting
29
+
- Automatic RSS feed generation
30
+
- SEO best practices (title tag, meta tags, canonical URLs)
28
31
29
32
Read more about the motivation + design behind Devii at [https://vriad.com/blog/devii](https://vriad.com/blog/devii).
30
33
31
34
## Get started
32
35
33
36
This repo contains the code for [https://devii.dev](https://devii.dev).
34
37
35
-
devii.dev serves as both the documentation AND a working demo of Devii. After you clone/fork it, you can look through the code to learn how Devii
36
-
works. Then you can rip out everything you don't like, customize
37
-
everything else, and build your own tools and components on top of the
38
-
foundation Devii provides!
38
+
devii.dev serves as both the documentation AND a working demo of Devii. After you clone/fork it, you can look through the code to learn how Devii works. Then you can rip out everything you don't like, customize everything else, and build your own tools and components on top of the foundation Devii provides!
39
39
40
-
Your personal website is the online manifestation of you. Devii
41
-
doesn't really provide much out of the box. It provides some nice
42
-
Medium-style default styles for your blog posts and some tools for
43
-
loading/rendering Markdown. But you'll have to implement your own
44
-
homepage more or less from scratch. And that's the point! Don't settle
45
-
for some theme. Build something that represents you.
40
+
Your personal website is the online manifestation of you. Devii doesn't really provide much out of the box. It provides some nice Medium-style default styles for your blog posts and some tools for loading/rendering Markdown. But you'll have to implement your own homepage more or less from scratch. And that's the point! Don't settle for some theme. Build something that represents you.
46
41
47
42
To get started:
48
43
@@ -58,8 +53,6 @@ To get started:
58
53
59
54
The core of this repo is [Next.js](https://https://nextjs.org). We chose Next.js because it's the simplest, most elegant way to generate a static version of a React-based website. The documentation is excellent; read it first: [Next.js Documentation](https://nextjs.org/docs).
60
55
61
-
The important con
62
-
63
56
## Project structure
64
57
65
58
Here's is an abbreviated version of the project structure. Certain config files (`next.config.js`, `next-end.d.ts`, `.gitignore`) have been removed for simplicity.
0 commit comments