ReadMe Documentation

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Search API

๐Ÿ‘

New Search API

You can now use our new Search API.

To use the search API, make a call to
https://{{project}}.readme.io/api/search?q={{query}}.

Example Request

curl https://readme.readme.io/api/v2.0/search/?q=subnav

Example Result

{  
   "hits":[  
      {  
         "title":"Subnavigation",
         "type":"basic",
         "slug":"subnavigation",
         "excerpt":"",
         "body":"There are multiple ways you can add a sub category to a specific page. The first method is to click on the + button on the page you want to nest it under.\n\n\n\n\t\n\t\t\n\t\n\nThe second method would be to simply click and drag the page underneath slightly to the right.",
         "isReference":false,
         "hidden":false,
         "link_url":"",
         "link_external":false,
         "_highlightResult":{  
            "title":{  
               "value":"<em>Subnav</em>igation",
               "matchLevel":"full",
               "fullyHighlighted":false,
               "matchedWords":[  
                  "subnav"
               ]
            },
            "type":{  
               "value":"basic",
               "matchLevel":"none",
               "matchedWords":[  

               ]
            },
            "slug":{  
               "value":"<em>subnav</em>igation",
               "matchLevel":"full",
               "fullyHighlighted":false,
               "matchedWords":[  
                  "subnav"
               ]
            },
            "excerpt":{  
               "value":"",
               "matchLevel":"none",
               "matchedWords":[  

               ]
            },
            "body":{  
               "value":"There are multiple ways you can add a sub category to a specific page. The first method is to click on the + button on the page you want to nest it under.\n\n\n\n\t\n\t\t\n\t\n\nThe second method would be to simply click and drag the page underneath slightly to the right.",
               "matchLevel":"none",
               "matchedWords":[  

               ]
            },
            "link_url":{  
               "value":"",
               "matchLevel":"none",
               "matchedWords":[  

               ]
            },
            "version":{  
               "value":"5f7ce9e3a5504d0414d0243f",
               "matchLevel":"none",
               "matchedWords":[  

               ]
            },
            "project":{  
               "value":"5f7ce9e3a5504d0414d025d0",
               "matchLevel":"none",
               "matchedWords":[  

               ]
            },
            "_tags":[  
               {  
                  "value":"project:5f7ce9e3a5504d0414d025d0",
                  "matchLevel":"none",
                  "matchedWords":[  

                  ]
               },
               {  
                  "value":"hidden:false",
                  "matchLevel":"none",
                  "matchedWords":[  

                  ]
               },
               {  
                  "value":"version:5f7ce9e3a5504d0414d0243f",
                  "matchLevel":"none",
                  "matchedWords":[  

                  ]
               }
            ]
         }
      }
   ]
}

Did this page help you?