-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadma.config.ts
46 lines (46 loc) · 1.48 KB
/
readma.config.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
import type * as types from './packages/core/src/types.ts'
import { md } from './packages/core/src/utils.ts'
const name = 'readma'
const author = 'elcoosp'
const urls = {
doc: `https://${name}.vercel.app/`,
}
const config: types.ReadmeTemplateArgs = {
language: 'ts',
title: 'Readma',
author,
githubUsername: author,
repoName: name,
xHandle: author,
domain: 'gmail',
email: author,
urls,
repobeats: '1b12e7ffd13fd2d15772a30e8b0a995976150797',
images: { screenshot: 'images/screenshot.gif', logo: 'images/logo.png' },
sections: {
features: `
- Workspace compatible
- Automatic shields
- Cross platform`,
projectDescription: 'Beautiful effortless README generator',
about: 'Create README that rocks',
installation: md.code(`deno install @${name}/core`),
acknowledgments: `
- [Best Readme](https://github.com/othneildrew/Best-README-Template)
- [Badges 4 README](https://github.com/alexandresanlim/Badges4-README.md-Profile)`,
gettingStarted: 'See screenshot',
usage: `🚧 In construction, refer to the [docs](${urls.doc})`,
roadmap: `
- [x] CLI with config file
- [x] Workspace readme generated from known files like \`Cargo.toml\`/\`deno.json\`/\`pnpm-workspace.yml\`
- [x] Github issue template links`,
'⛑️ Support':
'Software is still **very early** expect **unexpected breaking changes**',
},
template: {
bugReport: 'bug-report.yml',
featRequest: 'feature-request.yml',
},
backToTop: false,
} as const
export default config