Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please check the formatting of the project readme fiel #4

Open
pmario opened this issue Jun 14, 2023 · 4 comments
Open

Please check the formatting of the project readme fiel #4

pmario opened this issue Jun 14, 2023 · 4 comments

Comments

@pmario
Copy link

pmario commented Jun 14, 2023

@linonetwo ... Please check the formatting on the project readme page: https://github.com/tiddly-gittly/watch-fs ...

Are you sure, there should be that many H1 elements which are strange links

@linonetwo
Copy link
Contributor

Oh, it is just tid, that's why I want TiddlyWiki/TiddlyWiki5#6590

For now, this is the only choice. Use readme.tid, then there is no rendering, use readme.tid but fake as readme.md, it get at lease some rendering.

@linonetwo linonetwo closed this as not planned Won't fix, can't repro, duplicate, stale Jun 14, 2023
@pmario
Copy link
Author

pmario commented Jun 14, 2023

See: https://tiddlywiki.com/#Using%20TiddlyWiki%20for%20GitHub%20project%20documentation

There is a command eg: tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html that lets you render a ReadMe tiddler and save is as an html tiddler, which can be used to be shown at gh-pages.

TW uses this for https://github.com/Jermolene/TiddlyWiki5 ... The readme there is auto generated.

the --output full/path command can be used to automatically create the file in the right directory of the repo.

@linonetwo
Copy link
Contributor

That is good, let me see if I can run it in a github action and do that automatically. Is Jeremy generate readme.md manually?

@linonetwo linonetwo reopened this Jun 14, 2023
@pmario
Copy link
Author

pmario commented Jun 14, 2023

Is Jeremy generate readme.md manually?

I don't think so. IMO it's part of one of the deploy *.sh files. So I lost track about that file. Sorry.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants