@yamlresume/core 0.5.1 → 0.7.0

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 (7) hide show
  1. package/README.md +34 -7
  2. package/dist/index.d.ts +646 -1563
  3. package/dist/index.js +88 -86
  4. package/dist/index.js.map +1 -1
  5. package/package.json +1 -1
  6. package/dist/magic-string.es-PGO5ZCT3.js +0 -14
  7. package/dist/magic-string.es-PGO5ZCT3.js.map +0 -1
package/README.md CHANGED
@@ -1,10 +1,37 @@
1
- ## YAMLResume Core
1
+ # @yamlresume/core
2
2
 
3
- The YAMLResume Core is the core of [YAMLResume](https://yamlresume.dev). It is
4
- in charge of the typesetting and layout of the resume.
3
+ [![npm version](https://img.shields.io/npm/v/@yamlresume/core.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/@yamlresume/core)
4
+ [![npm downloads](https://img.shields.io/npm/dm/@yamlresume/core.svg?style=flat-square&logo=npm&color=CB3837)](https://www.npmjs.com/package/@yamlresume/core)
5
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)
6
+ [![Discord](https://img.shields.io/discord/1371488902023479336?style=flat-square&logo=discord&color=5865F2)](https://discord.gg/9SyT7mVV4K)
5
7
 
6
- ![YAMLResume YAML and PDF](https://yamlresume.dev/static/assets/images/yamlresume-yaml-and-pdf.webp)
8
+ This package contains the core engine for
9
+ [YAMLResume](https://yamlresume.dev). It handles parsing, validating, and
10
+ rendering resumes based on the official schema. It is intended for developers
11
+ who want to build custom tools or integrations on top of YAMLResume.
7
12
 
8
- Most likely you don't need to care about this package if you are not willing to
9
- build your own resume builder app. Check [YAMLResume
10
- CLI](https://yamlresume.dev/docs/cli) for end user cases.
13
+ **Note:** If you just want to create a resume, you should use the main
14
+ command-line tool. See the
15
+ [`yamlresume` package](https://www.npmjs.com/package/yamlresume) for more info.
16
+
17
+ ## The Design Principle
18
+
19
+ The core design principle of YAMLResume is
20
+ [Separation of Concerns](https://en.wikipedia.org/wiki/Separation_of_concerns).
21
+ The resume content (YAML) is decoupled from its presentation (LaTeX), allowing
22
+ the core engine to focus on one thing: compiling a structured document into a
23
+ beautifully typeset PDF.
24
+
25
+ ## Documentation
26
+
27
+ For more detailed information on the architecture and API, please visit our
28
+ official documentation:
29
+
30
+ - **[Compiler Architecture](https://yamlresume.dev/docs/compiler)**: An overview of the compilation process.
31
+ - **[Schema Reference](https://yamlresume.dev/docs/compiler/schema)**: The complete resume schema reference.
32
+
33
+ ## Support the Project
34
+
35
+ If you find YAMLResume helpful, consider supporting the project:
36
+
37
+ [![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/xiaohanyu)