https://github.com/jondashkyle/nanocontent
read directories of content into an object
https://github.com/jondashkyle/nanocontent
Last synced: 4 months ago
JSON representation
read directories of content into an object
- Host: GitHub
- URL: https://github.com/jondashkyle/nanocontent
- Owner: jondashkyle
- Created: 2017-10-25T04:36:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-22T18:32:16.000Z (almost 5 years ago)
- Last Synced: 2024-05-29T08:53:09.440Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.46 MB
- Stars: 80
- Watchers: 6
- Forks: 11
- Open Issues: 14
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
nanocontent
**work in progress...**
Introducing flat content state. Read directories of content into an object.
- Store all of your content in a directory
- Each directory is a page
- The content for each page is stored in a text file
- Your file system becomes a router!
- Pairs nicely with [`nanopage`](https://github.com/jondashkyle/nanopage) for traversing object structure
```
npm install nanocontent --save
```
## Usage
Format some plain text files using [smarkt](https://github.com/jondashkyle/smarkt) fields.
```
title: Technopastoral
----
date: January 19, 2038
----
tags:
- garden
- engineering
----
text: To deprogram oneself necessitates keeping to very specific schedules, which are what Foucault, once again, described as techniques of the self, echoing Seneca.
```
Organize them within a directory structure alongside media assets.
```
/content
/about
index.txt
/blog
/38-01-19-technopastoral
index.txt
header.jpg
index.txt
```
Turn the directory into an object.
```js
var nanocontent = require('nanocontent')
var site = nanocontent.readSiteSync('./content')
```
Each directory becomes a path containing a sub-object of the content in your text file.
```
{
'/': { },
'/about': { },
'/blog': { },
'/blog/30-01-19-technopastoral': { }
}
```
Map over the object keys to add routes to a router, then pass the content object. Huzzah.
## API
#### `.readFile(path, [options])`
#### `.readFiles(files, pathSite, [options])`
#### `.readPage(path, [options])`
#### `.readSite(path, [options])`
#### `.readFileSync(path, [options])`
#### `.readFilesSync(files, pathSite, [options])`
#### `.readPageSync(path, [options])`
#### `.readSiteSync(path, [options])`
## Options
#### `fs`
Provide a custom implementation of `fs`. Ensure the `mkdir` `readdir` `writeFile` and `readFile` methods are available. This is useful for replacing Node’s `fs` with Dat’s API, for instance.
#### `parse`
Substitute `smarkt` with your own parser. Must be able to transform a plain text file into a JSON object.
#### `parent`
Remove part of the `url` for pretty printing. For example, if your content lives in `/content`, but you don’t want to prefix all of your `urls` with `/content`, use `parent` to clean it up. Value can be a string or boolean. If `true`, the `path` of your initial call is used.
## Transform
```
browserify -t nanocontent/transform
```
A browserify transform located at `nanocontent/transform` is included to staticly inline the module output.
## Example
A demo site is included. Open the `nanocontent/example` dir and `npm install`. The example uses [Bankai](https://github.com/choojs/bankai). Run `npm start` to spin up a Bankai server and mess around. Run `bankai build` to build a fully static site.
## Todo
- [ ] Tests
- [ ] Async callback/promise fallback
- [x] Modularize read function for JSON/Smarkt/Custom