@travetto/doc 3.1.0-rc.1 → 3.1.0-rc.3

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 (4) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -3
  3. package/src/render/html.ts +1 -1
  4. package/src/render/markdown.ts +1 -1
package/README.md CHANGED
@@ -152,6 +152,6 @@ Sample documentation for fictional module. This module fictitiously relies upon
152
152
  Usage: <span class="token punctuation">[</span>options<span class="token punctuation">]</span> <span class="token punctuation">[</span>command<span class="token punctuation">]</span>
153
153
 
154
154
  Commands:
155
- doc Command line support <span class="token keyword">for</span> generating module docs.</code></pre>
155
+ doc Command line support <span class="token keyword">for</span> generating module docs.</code></pre>
156
156
  </figure>
157
157
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@travetto/doc",
3
- "version": "3.1.0-rc.1",
3
+ "version": "3.1.0-rc.3",
4
4
  "description": "Documentation support for the Travetto framework",
5
5
  "keywords": [
6
6
  "docs",
@@ -24,12 +24,12 @@
24
24
  "directory": "module/doc"
25
25
  },
26
26
  "dependencies": {
27
- "@travetto/base": "^3.1.0-rc.0",
27
+ "@travetto/base": "^3.1.0-rc.2",
28
28
  "@types/prismjs": "^1.26.0",
29
29
  "prismjs": "^1.29.0"
30
30
  },
31
31
  "peerDependencies": {
32
- "@travetto/cli": "^3.1.0-rc.1"
32
+ "@travetto/cli": "^3.1.0-rc.5"
33
33
  },
34
34
  "peerDependenciesMeta": {
35
35
  "@travetto/cli": {
package/src/render/html.ts CHANGED
@@ -144,7 +144,7 @@ yarn add ${el.props.pkg}
144
144
  Header: async ({ props }) => `<h1>${props.title} ${props.description ? `\n<small>${props.description}</small>\n` : ''}</h1>\n`,
145
145
 
146
146
  StdHeader: async state => {
147
- const mod = state.el.props.mod ?? RootIndex.mainPackage.name;
147
+ const mod = state.el.props.mod ?? RootIndex.mainModuleName;
148
148
  const pkg = PackageUtil.readPackage(RootIndex.getModule(mod)!.sourcePath);
149
149
  const title = pkg.travetto?.displayName ?? pkg.name;
150
150
  const desc = pkg.description;
package/src/render/markdown.ts CHANGED
@@ -108,7 +108,7 @@ ${context.cleanText(content.text)}
108
108
  Header: async ({ props }) => `# ${props.title}\n${props.description ? `## ${props.description}\n` : ''}\n`,
109
109
 
110
110
  StdHeader: async state => {
111
- const mod = state.el.props.mod ?? RootIndex.mainPackage.name;
111
+ const mod = state.el.props.mod ?? RootIndex.mainModuleName;
112
112
  const pkg = PackageUtil.readPackage(RootIndex.getModule(mod)!.sourcePath);
113
113
  const title = pkg.travetto?.displayName ?? pkg.name;
114
114
  const desc = pkg.description;