Skip to content

How do I add the "What's next?" #853

Closed Answered by kanadgupta
thenerdassassin asked this question in Q&A
Discussion options

You must be logged in to vote

Hi there!

The attributes you're asking about are technically an undocumented part of ReadMe's Docs API. As a disclaimer, these attributes are deliberately undocumented and might change without warning. For the upcoming version of the API (details to come), we should have better coverage on this front!

As of this writing, you can sync using rdme docs, you can specify the following attributes in the YAML front matter of your Markdown docs and an object like this will set the "What's Next" attributes:

next:
  pages:
    - name: Example Page
      slug: getting-started
      type: doc
      category: Documentation
    - type: url
      value: "https://google.com"
      name: some external link

Replies: 1 comment

Comment options

You must be logged in to vote
0 replies
Answer selected by kanadgupta
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
question Further information is requested command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands API Underlying issue is with the ReadMe API and not necessarily the `rdme` client itself
2 participants