An open API service indexing awesome lists of open source software.

https://github.com/ogty/desktop-articles-manager

📝 Manage articles to be placed on the desktop.
https://github.com/ogty/desktop-articles-manager

articles commad-line desktop macos manager marp pdf tool

Last synced: about 1 month ago
JSON representation

📝 Manage articles to be placed on the desktop.

Awesome Lists containing this project

README

          

Desktop Articles Manager


sample image

## ⚙️ Setup

```zsh
$ cd ~/
$ git clone https://github.com/ogty/desktop-articles-manager.git
$ source ./desktop-articles-manager.git/setup.sh
```

## 📖 Usage

```zsh
$ artima # All files are eligible
$ artima head 3
$ artima tail 2
```

`head` creates the files in the order they were updated; `tail` creates the files starting with the oldest.

You can limit the number of PDFs generated by giving a number as an argument.

The default value is `5`.

## ✏️ Example

**~/Desktop/articles/articles_about_docker.md**

```md
---
icon: "docker-original"
---
# Articles About Docker
```

> **Note**

> If `icon` is not specified, the `pdf` icon will be displayed.

## When using Marp

```md
---
icon: "docker-original"
marp: true
theme: "gaia"
---
# Articles About Docker
```

> **Note**

> By preparing your own CSS design file directly under `marp`,

> you can set the file name to theme and that design will be applied.
> ```md
> ---
> marp: true
> theme: "dracula"
> ---
> ```

## 📍 Items that can be specified

| Key | Value | Description |
| ------ | ------- | ------------------------------------------------------------------------------------------------- |
| icon | string | Icon name of PDF file. [Icon name that can be specified](https://github.com/ogty/iconic-commands) |
| marp | boolean | Whether to create in Marp |
| create | boolean | Whether to create it in the first place |
| theme | string | Marp Theme |