create-lettercamp 0.1.23 → 0.1.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -19
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -1,30 +1,78 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://www.lettercamp.com">
|
|
3
|
+
<img src="https://static.lettercamp.com/assets/lettercamp/static/jE0Iuuw7Fxmx-lettercamp-cover.webp" alt="Lettercamp — modern, open-source publication platform" width="100%">
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
<h1 align="center">Lettercamp</h1>
|
|
4
8
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
9
|
+
<p align="center">
|
|
10
|
+
An open-source framework for beautiful, modern content publications.<br>
|
|
11
|
+
Designed and built for the AI era with full compatibility with agent workflows.<br>
|
|
12
|
+
Write content in Markdown or MDX, preview locally, and publish on your own terms.
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="https://www.lettercamp.com/docs">Documentation</a> ·
|
|
17
|
+
<a href="#quick-start">Quick start</a> ·
|
|
18
|
+
<a href="https://www.lettercamp.com/docs/cli">CLI reference</a> ·
|
|
19
|
+
<a href="https://www.lettercamp.com">Lettercamp Cloud</a>
|
|
20
|
+
</p>
|
|
21
|
+
|
|
22
|
+
<br>
|
|
23
|
+
|
|
24
|
+
## The easiest way to create a beautiful content site
|
|
25
|
+
|
|
26
|
+
Lettercamp is a free and open-source platform that makes it easy to create and manage a modern content publication. The framework ships with all the features you expect from a modern content site, including markdown and MDX support, search, table of contents, related articles, author profiles, and much more.
|
|
27
|
+
|
|
28
|
+

|
|
29
|
+
|
|
30
|
+
- **Write in Markdown and MDX.** Keep your content in files and make it easier for your agent to draft and edit content without relying on a database.
|
|
31
|
+
- **Spin up a modern content site quickly.** Lettercamp ships everything you need to publish and more, so you can focus on creating and publishing the best content possible.
|
|
32
|
+
- **Customize to your brand** Easily replace brand logos, fonts, and colors so that your publication reflects your brand.
|
|
33
|
+
- **Free and open-source** The core Lettercamp framework is [MIT-licensed](LICENSE), giving you complete control over your content, publication, and deploys. Our company operates [Lettercamp Cloud](https://www.lettercamp.com), which offers an hosted version.
|
|
34
|
+
|
|
35
|
+
## Why Lettercamp?
|
|
36
|
+
|
|
37
|
+
If you want to start publishing content on your domain, you'll have to build a content site that supports rendering articles, post pages, pagination, authors, SEO features, and much more. Lettercamp provides all of these features (and more) out of the box, letting you focus on building your own product instead of building a content site.
|
|
38
|
+
|
|
39
|
+
Existing solutions require building your entire website on a third party provider, or managing a headless CMS which contains your content in a third party database. Lettercamp solves these issues by providing an entire site as a static site, which means published content pages are fast, performant, and easier to manage.
|
|
8
40
|
|
|
9
|
-
|
|
10
|
-
|
|
41
|
+
Finally, Lettercamp is designed to be the easiest way to connect your content to an AI agent. Instead of drafting articles and then copying and pasting them into a third party site, with Lettercamp your agent can directly iterate on the code to draft articles and create interactive content experiences.
|
|
42
|
+
|
|
43
|
+
## MIT license
|
|
44
|
+
|
|
45
|
+
This Lettercamp repository contains the core framework for building and managing a content publication. It is [MIT-licensed](LICENSE).
|
|
46
|
+
|
|
47
|
+
## Quick start
|
|
48
|
+
|
|
49
|
+
Create your first publication:
|
|
11
50
|
|
|
12
51
|
```bash
|
|
13
|
-
|
|
52
|
+
npm create lettercamp@latest my-lettercamp-site
|
|
53
|
+
cd my-lettercamp-site
|
|
14
54
|
npm run dev
|
|
15
|
-
npm run deploy
|
|
16
55
|
```
|
|
17
56
|
|
|
18
|
-
|
|
57
|
+
See the [documentation](https://www.lettercamp.com/docs) for customization and
|
|
58
|
+
[publishing with the CLI](https://www.lettercamp.com/docs/cli), or use
|
|
59
|
+
[Lettercamp Cloud](https://www.lettercamp.com) for a web editor and managed hosting.
|
|
19
60
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
61
|
+
## Lettercamp Cloud
|
|
62
|
+
|
|
63
|
+
Lettercamp Cloud is the hosted platform for deploying and managing Lettercamp sites. In addition to providing hosting for the built sites, Lettercamp Cloud also offers a web-based editor and dashboard, which allows your content team to edit and manage content without needing to commit code. This product also includes several enterprise ready features, including access control, user management, payments, and more. However, the core publication site remains the same as the open-source offering.
|
|
64
|
+
|
|
65
|
+
## Contributing
|
|
66
|
+
|
|
67
|
+
Bug reports, fixes, documentation improvements, and feature ideas are welcome.
|
|
68
|
+
[Open an issue](https://github.com/lettercamp/lettercamp/issues) to report a problem
|
|
69
|
+
or discuss a larger change before starting work.
|
|
70
|
+
|
|
71
|
+
For local development, use the Node.js version in [`.nvmrc`](.nvmrc), then run
|
|
72
|
+
`npm ci` and `npm run dev`. Before opening a pull request, run `npm run check` and
|
|
73
|
+
`npm run build`, and describe how you verified your changes.
|
|
24
74
|
|
|
25
|
-
|
|
26
|
-
`--no-install` to install dependencies later with `npm install`. Without a
|
|
27
|
-
terminal, unanswered questions use defaults. The destination must be new or empty.
|
|
28
|
-
Existing global installations are not changed.
|
|
75
|
+
## License and assets
|
|
29
76
|
|
|
30
|
-
|
|
77
|
+
Code is licensed under the [MIT license](LICENSE). The Lettercamp name and
|
|
78
|
+
logo do not grant permission to imply official affiliation.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-lettercamp",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.25",
|
|
4
4
|
"description": "Create a new Lettercamp site",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"lettercamp",
|
|
@@ -31,8 +31,11 @@
|
|
|
31
31
|
"files": [
|
|
32
32
|
"bin"
|
|
33
33
|
],
|
|
34
|
+
"scripts": {
|
|
35
|
+
"prepack": "tsx ../scripts/package-readme.ts"
|
|
36
|
+
},
|
|
34
37
|
"dependencies": {
|
|
35
|
-
"@lettercamp/cli": "0.1.
|
|
38
|
+
"@lettercamp/cli": "0.1.25"
|
|
36
39
|
},
|
|
37
40
|
"license": "MIT"
|
|
38
41
|
}
|