Skip to content
This repository was archived by the owner on Jun 14, 2024. It is now read-only.

Commit 7f1436f

Browse files
author
Colin McDonnell
committed
Added features.md and introduction.md
1 parent 8f4a4c3 commit 7f1436f

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,23 @@ if you're happy and you know it, star this repo
2121

2222
A dev blog starter for 2020.
2323

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)
2627
- 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)
2831

2932
Read more about the motivation + design behind Devii at [https://vriad.com/blog/devii](https://vriad.com/blog/devii).
3033

3134
## Get started
3235

3336
This repo contains the code for [https://devii.dev](https://devii.dev).
3437

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!
3939

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.
4641

4742
To get started:
4843

@@ -58,8 +53,6 @@ To get started:
5853

5954
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).
6055

61-
The important con
62-
6356
## Project structure
6457

6558
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.

public/danabramov_thumb.png

529 Bytes
Loading

0 commit comments

Comments
 (0)