create-lettercamp 0.1.22 → 0.1.24

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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +65 -19
  3. package/package.json +10 -6
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Eric Lu
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,30 +1,76 @@
1
- # Create Lettercamp
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
- Create a Lettercamp site with one command (Node.js 22.23.4 or newer):
7
+ <h1 align="center">Lettercamp</h1>
4
8
 
5
- ```bash
6
- npm create lettercamp@latest
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
+ ## The easiest way to create a beautiful content site
23
+
24
+ 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.
25
+
26
+ ![Lettercamp publication](https://static.lettercamp.com/assets/lettercamp/static/6IeBxgBIS5b1-lettercamp-blog-example.webp)
27
+
28
+ - **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.
29
+ - **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.
30
+ - **Customize to your brand** Easily replace brand logos, fonts, and colors so that your publication reflects your brand.
31
+ - **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.
32
+
33
+ ## Why Lettercamp?
34
+
35
+ 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.
36
+
37
+ 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
38
 
9
- Or use `npx create-lettercamp@latest`. Setup asks for a folder and starter preset,
10
- then installs the Lettercamp CLI inside the new project.
39
+ 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.
40
+
41
+ ## MIT license
42
+
43
+ This Lettercamp repository contains the core framework for building and managing a content publication. It is [MIT-licensed](LICENSE).
44
+
45
+ ## Quick start
46
+
47
+ Create your first publication:
11
48
 
12
49
  ```bash
13
- cd my-lettercamp
50
+ npm create lettercamp@latest my-lettercamp-site
51
+ cd my-lettercamp-site
14
52
  npm run dev
15
- npm run deploy
16
53
  ```
17
54
 
18
- To supply choices directly:
55
+ See the [documentation](https://www.lettercamp.com/docs) for customization and
56
+ [publishing with the CLI](https://www.lettercamp.com/docs/cli), or use
57
+ [Lettercamp Cloud](https://www.lettercamp.com) for a web editor and managed hosting.
19
58
 
20
- ```bash
21
- npm create lettercamp@latest my-blog -- --preset dark --yes
22
- npx create-lettercamp@latest my-blog --preset dark --yes
23
- ```
59
+ ## Lettercamp Cloud
60
+
61
+ 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.
62
+
63
+ ## Contributing
64
+
65
+ Bug reports, fixes, documentation improvements, and feature ideas are welcome.
66
+ [Open an issue](https://github.com/lettercamp/lettercamp/issues) to report a problem
67
+ or discuss a larger change before starting work.
68
+
69
+ For local development, use the Node.js version in [`.nvmrc`](.nvmrc), then run
70
+ `npm ci` and `npm run dev`. Before opening a pull request, run `npm run check` and
71
+ `npm run build`, and describe how you verified your changes.
24
72
 
25
- Use `--preset default` for the default starter, `--yes` to skip questions, or
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.
73
+ ## License and assets
29
74
 
30
- See the [Lettercamp documentation](https://www.lettercamp.com/docs/cli).
75
+ Code is licensed under the [MIT license](LICENSE). The Lettercamp name and
76
+ 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.22",
3
+ "version": "0.1.24",
4
4
  "description": "Create a new Lettercamp site",
5
5
  "keywords": [
6
6
  "lettercamp",
@@ -14,12 +14,12 @@
14
14
  },
15
15
  "repository": {
16
16
  "type": "git",
17
- "url": "git+https://github.com/lettercamp/cli.git",
17
+ "url": "git+https://github.com/lettercamp/lettercamp.git",
18
18
  "directory": "create"
19
19
  },
20
- "homepage": "https://github.com/lettercamp/cli#readme",
20
+ "homepage": "https://github.com/lettercamp/lettercamp#readme",
21
21
  "bugs": {
22
- "url": "https://github.com/lettercamp/cli/issues"
22
+ "url": "https://github.com/lettercamp/lettercamp/issues"
23
23
  },
24
24
  "publishConfig": {
25
25
  "access": "public",
@@ -31,7 +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.22"
36
- }
38
+ "@lettercamp/cli": "0.1.24"
39
+ },
40
+ "license": "MIT"
37
41
  }