logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ikiwiki Plug-in: h1title

Author

       Jason Blevins <jrblevin@sdf.lonestar.org>,

License

       Copyright (C) 2008 Jason Blevins

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU
       General Public License as published by the Free Software Foundation; either version 2 of the License, or
       (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
       the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
       License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write
       to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

perl v5.40.1                                       2025-05-02                      IkiWiki::Plugin::h1title(3pm)

Name

       ikiwiki Plug-in: h1title

See Also

       ikiwiki Homepage: http://ikiwiki.info/

       ikiwiki Plugin Documentation: http://ikiwiki.info/plugins/write/

Synopsis

       If there is a level 1 Markdown atx-style (hash mark) header on the first line, this plugin uses it to set
       the page title and removes it from the page body so that it won't be rendered twice.  Level 1 headers in
       the remainder of the page will be ignored.

       For example, the following page will have title "My Title" and the rendered page body will begin with the
       level two header "Introduction."

           # My Title

           ## Introduction

           Introductory text with a list:

            * Item 1
            * Item 2

           ## Second header

           Second section

       This plugin can be used with page templates that use <h1> tags for the page title to produce a consistent
       header hierarchy in rendered pages while keeping the Markdown source clean and free of meta directives.

See Also