Skip to content

Commit 7fac61b

Browse files
committed
inserted step 5: pipenvshell. updated formatting
1 parent 37fdb5a commit 7fac61b

File tree

1 file changed

+50
-11
lines changed

1 file changed

+50
-11
lines changed

README.md

+50-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,62 @@
1-
# Source for creativecommons.github.io
1+
# creativecommons.github.io-source
2+
3+
Source for creativecommons.github.io
4+
5+
6+
## Overview
7+
8+
This site is built using [Lektor][lektor]. All changes to
9+
[https://creativecommons.github.io][[ccgithubio] must be made **here** and
10+
deployed via lektor (see [Deploying](#deploying), below).
11+
12+
**DO NOT MAKE CHANGES TO THE [creativecommons.github.io][ccghiorepo] REPO
13+
DIRECTLY**.
14+
15+
[lektor]:https://www.getlektor.com/
16+
[ccgithubio]:https://creativecommons.github.io
17+
[ccghiorepo]:https://github.com/creativecommons/creativecommons.github.io
218

3-
This site is built using [Lektor](https://www.getlektor.com/). All changes to [https://creativecommons.github.io](https://creativecommons.github.io) must be made here and deployed automatically. **DO NOT MAKE CHANGES TO THE [creativecommons.github.io](https://github.com/creativecommons/creativecommons.github.io) REPO DIRECTLY**.
419

520
## Making changes
621

7-
1. Make sure you have [pipenv](https://pipenv.readthedocs.io/en/latest/) installed.
22+
1. Make sure you have [pipenv][pipenvdocs] installed.
823
1. Clone this repository.
924
1. Open your command line interface and `cd` to the repository root directory.
10-
1. Run `pipenv install` to create a Python virtual environment and install the requirements for this project.
11-
1. Run `lektor server` to start the Lektor development server. You will be able to see the website at `http://localhost:5000/`. The Lektor server will rebuild the site every time you change any content.
25+
1. Run `pipenv install` to create a Python virtual environment and install the
26+
requirements for this project.
27+
1. Run `pipenv shell` to spawn a shell with the virtualenv activated
28+
1. Run `lektor server` to start the Lektor development server. You will be able
29+
to see the website at [`http://localhost:5000/`][lektorlocal]. The Lektor
30+
server will rebuild the site every time you change any content.
31+
32+
[pipenvdocs]:https://pipenv.readthedocs.io/en/latest/
33+
[lektorlocal]:http://localhost:5000/
34+
1235

1336
## Project structure
1437

15-
Here's how the code is structured in the top level of the repository:
16-
- `assets`: This directory contains the JavaScript and CSS files for the project. Most of the JavaScript and CSS is third-party code and loaded via CDN so this is pretty empty.
17-
- `content`: The content of the site lives here. [Here's an explanation of how content works in Lektor](https://www.getlektor.com/docs/content/). This is probably what you'll be modifying most often.
18-
- `models`: [All content in Lektor is associated with data models](https://www.getlektor.com/docs/models/) to define their schema. Currently, we only use the default `page` model that ships with Lektor.
19-
- `templates`: This is where the [Jinja2](http://jinja.pocoo.org/) templates that render content are stored. See the [Lektor template documentation](https://www.getlektor.com/docs/templates/) for more information.
38+
Here's how the code is structured in the top level of the repository:
39+
- `assets`: This directory contains the JavaScript and CSS files for the
40+
project. Most of the JavaScript and CSS is third-party code and loaded via
41+
CDN so this is pretty empty.
42+
- `content`: The content of the site lives here. [Here's an explanation of how
43+
content works in Lektor][lektorcontent]. This is probably what you'll be
44+
modifying most often.
45+
- `models`: [All content in Lektor is associated with data
46+
models][lektormodels] to define their schema. Currently, we only use the
47+
default `page` model that ships with Lektor.
48+
- `templates`: This is where the [Jinja2][jinja2] templates that render content
49+
are stored. See the [Lektor template documentation][lektortemplate] for more
50+
information.
51+
52+
[lektorcontent]:https://www.getlektor.com/docs/content/
53+
[lektormodels]:(https://www.getlektor.com/docs/models/
54+
[jinja2]:http://jinja.pocoo.org/
55+
[lektortemplate]:https://www.getlektor.com/docs/templates/
56+
2057

2158
## Deploying
2259

23-
When you are ready to deploy a new version of the site, run `lektor deploy` (assuming you have your GitHub SSH key set up already). That's it, it's live on production!
60+
When you are ready to deploy a new version of the site, run `lektor deploy`
61+
(assuming you have your GitHub SSH key set up already). That's it, it's live on
62+
production!

0 commit comments

Comments
 (0)