You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Markdown injection currently places a block like this:
File: foo/bar.jsconsole.log('Hello World')
We traditionally document files, instead, like this:
// foo/bar.jsconsole.log('Hello World')
We should find a library or write up some code that takes our common markdown languages and creates file name comments out of them. In some cases (like json), we may just need to retain the File: ___ message.
Examples:
<!-- index.html --><div>Hello World</div>
# deploy.sh
npm run release
git push --follow-tags origin main
# .vela.ymlsteps:
- name: testimage: nodecommands:
- npm i
- npm test
Markdown injection currently places a block like this:
We traditionally document files, instead, like this:
We should find a library or write up some code that takes our common markdown languages and creates file name comments out of them. In some cases (like
json
), we may just need to retain theFile: ___
message.Examples:
# deploy.sh npm run release git push --follow-tags origin main
Alternatively, we could document JSON as json5
Languages we have
```[lang]
blocks of in the monorepo currently:bash
diff
docker
js
json
jsx
markdown
nginx
sh
ts
txt
yaml
Languages we don't have but should probably support because they might sneak in:
yml
(I usually writeyaml
this way)tsx
json5
?The text was updated successfully, but these errors were encountered: