https://github.com/elipapa/sample-datocms-jekyll-portfolio
https://github.com/elipapa/sample-datocms-jekyll-portfolio
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elipapa/sample-datocms-jekyll-portfolio
- Owner: elipapa
- Created: 2017-01-19T13:34:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-19T13:34:55.000Z (over 8 years ago)
- Last Synced: 2025-01-14T14:58:31.046Z (9 months ago)
- Language: CSS
- Size: 40 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jekyll Portfolio Website
This repo contains a working static website written with [Jekyll](https://jekyllrb.com), integrated with content coming from a [DatoCMS](https://www.datocms.com) administrative area.
## Usage
First, install the dependencies of this project:
```
yarn install
```
Then, to run this website in development mode (with live-reload):
```
yarn start
```
To build the final, production ready static website:
```
yarn build
```
The final result will be saved in the `public` directory.
## About
The goal of this project is to show how easily you can create static sites using the content (text, images, links, etc.) stored on [DatoCMS](https://www.datocms.com). This project is configured to fetch data from a specific administrative area using [the API DatoCMS provides](https://www.datocms.com/docs/api/sma/).
This websites uses:
* [Yarn](https://yarnpkg.com/) as package manager;
* [Webpack](https://webpack.github.io/) to compile and bundle assets (Sass/ES2015 JS);
* [dato](https://github.com/datocms/ruby-datocms-client) gem to integrate the website with DatoCMS.
## The `dato.config.rb` file
To convert the content stored on DatoCMS into local Markdown files that can be digested by Jekyll, the datocms-client plugin requires an explicit mapping file called [`dato.config.js`](https://github.com/datocms/jekyll-portfolio/blob/master/dato.config.rb). You can read more about the commands available in this file [in the plugin documentation](https://github.com/datocms/ruby-datocms-client/blob/master/docs/dato-cli.md).