# Install with distributed tools on a decentralized system
npm install -g 'git+https://git.daplie.com/Daplie/deardesi.git#v1'

# Install with the centralized, concentrated hypocrinet
npm install -g desi

That was easy

Quick Usage

desi init -d ~/Desktop/new-blog
pushd ~/Desktop/new-blog
desi post "my first post"
desi build
desi serve

http://local.dear.desi:65080

Note: both through command line and web you need site.yml and authors/xyz.yml configured in order to create a post (as well as build). The post commands output the location of post in various formats.

Initialize your blog (step 1)

You can do this 3 ways:

Create a new blog with desi init -d ~/Desktop/blog
Clone the seed project and themes yourself
Clone the seed project and import your posts and themes

Automated (desi init)

# initialize (and or create) a blog directory
desi init -d ~/Desktop/blog

# initialize the current directory
pushd ~/Desktop/blog
desi init

Note that you cannot initialize a directory that is already in use (where 'in use' means has at least one non-dotfile).

Manual (clone yourself)

There are a number of themes available at https://github.com/DearDesi, just look for ones with 'theme' in the description.

git clone git@github.com:DearDesi/desirae-blog-template.git ~/my-desirae-blog
pushd ~/my-desirae-blog

git submodule add git@github.com:DearDesi/ruhoh-bootstrap-2.git themes/ruhoh-bootstrap-2

You will need to make sure that you have some details about your theme in config.yml. Basically that means that you specify a datamap and which defaults for a page and post in the layouts folder.

Just open it up, it'll make sense.

Migrate (import another blog)

Obviously this is a little different for everyone, so here's what I'd recommend:

start by following the Automated procedure above
copy over your posts/articles folder(s)
edit config.yml to add a config with a permalink with your collections (posts, articles, essays, whatever you call them)
skip ahead to the Setup your blog section and make sure your site.yml and authors/xxx.yml are correct.
run desi build -d /path/to/blog to test if there are any issues with your existing yaml

if there are, you can take a look at the normalize function and perhaps hand-edit a few things (and when you're ready, you can register your transform for collections.

Now copy over your theme and set it to be the default in site.yml
build again. Your site probably won't look right:

look for stuff like urls.base_url, host, page.url that might have an extra / at the beginning or end or be named slightly differently.

See https://github.com/DearDesi/desirae/blob/master/GLOSSARY.md for disambiguation about the meaning of terms in Desi.

Setup your blog (step 2)

Create an authors file in authors/YOUR_NAME.yml and model it after this example

You don't need to use all of the fields (your template might not even support them all)

Create a site file as site.yml, similar to this example

Important Things

site.yml.base_url - the point of ownership (usually blog.example.com or example.com)
site.yml.base_path - where the blog is "mounted", relative to the base_url (usually / or /blog)
authors/me.yml.name - most templates use this
authors/me.yml.email - and this
authors/me.yml.twitter - and this

Build your blog (step 2)

The build will fail if you don't have site.yml and authors/johndoe.yml configured.

desi build -d /path/to/blog

desi serve -d /path/to/blog

Now open up your evergreen browser to http://local.dear.desi:65080

License

This Source Code Form is subject to the terms of the Mozilla
Public License, v. 2.0. If a copy of the MPL was not distributed
with this file, You can obtain one at
https://mozilla.org/MPL/2.0/.

Keywords

FAQs

What is desi?

Is desi well maintained?

Package last updated on 09 Nov 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install