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.

Sign up for GitHub

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

Jump to bottom

how to rename the generated REAMDE.md to index.md ? #176

Closed
arvinxx opened this issue Jan 3, 2021 · 2 comments
Closed

how to rename the generated REAMDE.md to index.md ? #176

arvinxx opened this issue Jan 3, 2021 · 2 comments

Comments

@arvinxx
Copy link

arvinxx commented Jan 3, 2021

image

it seems that it will always generate readme File as README.md. By in my case I want to generated the README.md to index.md.

is there any configuration to control this?
tgreyuk added a commit that referenced this issue Jan 3, 2021
@tgreyuk
#176: Added entryFile option
9364b06
@tgreyuk
Copy link
Member

tgreyuk commented Jan 5, 2021

[email protected] contains new option entryDocument

entryDocument 'index.md'

Vinnl added a commit to inrupt/solid-client-js that referenced this issue Jan 6, 2021
@Vinnl
Use index.html as the API reference index
7e332a5 
It used to be README.md, which didn't make much sense.
This option was added in typedoc-plugin-markdown v3.3.0:
typedoc2md/typedoc-plugin-markdown#176
@Vinnl Vinnl mentioned this issue Jan 6, 2021
Merged
1 task
Vinnl added a commit to inrupt/solid-client-js that referenced this issue Jan 6, 2021
@Vinnl
Use index.html as the API reference index
9eccf77 
It used to be README.md, which didn't make much sense.
This option was added in typedoc-plugin-markdown v3.3.0:
typedoc2md/typedoc-plugin-markdown#176
Vinnl added a commit to inrupt/solid-client-js that referenced this issue Jan 6, 2021
@Vinnl
Use index.html as the API reference index
622c0e6 
It used to be README.md, which didn't make much sense.
This option was added in typedoc-plugin-markdown v3.3.0:
typedoc2md/typedoc-plugin-markdown#176
Vinnl added a commit to inrupt/solid-client-js that referenced this issue Jan 6, 2021
@Vinnl
Use index.html as the API reference index
c3f8c7e 
It used to be README.md, which didn't make much sense.
This option was added in typedoc-plugin-markdown v3.3.0:
typedoc2md/typedoc-plugin-markdown#176
@arvinxx
Copy link
Author

arvinxx commented Jan 6, 2021

work well~ thanks a lot.

@arvinxx arvinxx closed this as completed Jan 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tgreyuk @arvinxx