mozilla
Your Search Results

    API landing page guide

    1. An API landing page is an article that provides an overview of what a related collection of interfaces, objects, and other API terms do and are used for. Consider, for example, the API landing page for the IndexedDB API.

    The page begins with an overview of what the API does, then offers links to the documentation for each of the interfaces, globals, functions, etc. offered by the API. It does not link directly to specific methods or properties within the API's classes, except in the context of the API's overview.

    Update this page once the new API reference design is complete.

    Automatic updating

    Landing pages use macros to help automatically generate and update their content. This ensures that new methods and properties are automatically listed on the page, without the writer having to manually add them. This is a helpful convenience for our long-time contributors, and helps newcomers avoid having their work lost in the shuffle because they didn't know how to link their articles into the site hierarchy.

    For this automatic updating to work, you need to click "Edit page title and properties" while in the page's editor, then set a "Rendering max age." This time tells the Kuma platform on which MDN runs to rebuild the cached page, including re-running its macros, on a schedule. Typically, we use 4 or 8 hours for this. For an API whose documentation is changing rapidly, you might choose a lower number.

    Note: The "Edit page title and properties" option is not available when creating a new page; you'll have to re-open the editor after your first save.

     

    Document Tags and Contributors

    Contributors to this page: Sheppy, redjon76
    Last updated by: redjon76,
    Hide Sidebar