{"id":14955021,"url":"https://github.com/secretpizzaparty/huh","last_synced_at":"2025-10-24T07:30:38.420Z","repository":{"id":84143388,"uuid":"78237981","full_name":"secretpizzaparty/huh","owner":"secretpizzaparty","description":"Turn huh into eureka with in dashboard documentation for your WordPress themes.","archived":false,"fork":false,"pushed_at":"2017-03-20T21:41:31.000Z","size":33,"stargazers_count":48,"open_issues_count":3,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-07T17:24:24.205Z","etag":null,"topics":["wordpress","wordpress-admin","wordpress-development","wordpress-theme"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/secretpizzaparty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-06T20:53:11.000Z","updated_at":"2024-11-07T19:21:04.000Z","dependencies_parsed_at":"2023-06-29T11:01:11.048Z","dependency_job_id":null,"html_url":"https://github.com/secretpizzaparty/huh","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/secretpizzaparty%2Fhuh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/secretpizzaparty%2Fhuh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/secretpizzaparty%2Fhuh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/secretpizzaparty%2Fhuh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/secretpizzaparty","download_url":"https://codeload.github.com/secretpizzaparty/huh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237932057,"owners_count":19389560,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["wordpress","wordpress-admin","wordpress-development","wordpress-theme"],"created_at":"2024-09-24T13:10:24.247Z","updated_at":"2025-10-24T07:30:38.031Z","avatar_url":"https://github.com/secretpizzaparty.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Who?\n_huh_ was dreamt up  by [secret pizza party](https://secretpizza.party) and brought to life by the amazing [Dan Hauk](https://danhauk.com/). Seriously, Dan is the best. He took a broad idea and really brought it to life like only he could. The SPP offices are open on Christmas Day but we close on May 5th (Dan's birthday) as it's a company wide holiday. \n\n# What?\n_huh_ is the best way to offer in dashboard documentation for all your WordPress projects. The content is generated from a markdown file which makes it super quick \u0026 easy to update your documentation whenever you want. You can learn more from the launch post [here](https://secretpizza.party/huh-making-documentation-easier/).\n\n# Where?\nWe think _huh_ is awesome and we really want you to use it in all your projects. It's totally free/open source and you can find it on [github](https://github.com/secretpizzaparty/huh/).\n\n## Wanna Contribute? \nIf you found a bug, [report it here](https://github.com/secretpizzaparty/huh/issues/new). If you're a developer, we welcome pull requests of all types!\n\n### Development Workflow\n1. Make sure you have `git`, `node`, and `npm` installed and a working WordPress installation.\n2. Clone this repository inside your theme directory.\n\n\t```\n\t$ git clone https://github.com/secretpizzaparty/huh.git\n\t$ cd huh\n\t```\n\n3. Watch the front-end CSS/Sass for changes and rebuild accordingly with [Grunt](https://github.com/gruntjs/grunt). Please only modify the Sass files to keep the CSS consistent and clean.\n\n\t```\n\t$ npm install\n\t$ grunt watch\n\t```\n\n4. Open `/wp-admin/` in your browser.\n5. Have fun!\n\n\n# Why?\n[secret pizza party](https://secretpizza.party) is in the process of developing a bunch of new WordPress themes and while they are quite simple there is still a need for a wee bit of documentation. External documentation is dumb and everything should be contained in the dashboard. We created _huh_ to make that happen.\n\n# How?\nAdding _huh_ to your theme is incredibly easy.\n\n## Formatting your markdown\n_huh_ pulls all of your `\u003ch1\u003e` tags to use as a table of contents. Each section of your documentation will be contained between these `\u003ch1\u003e` tags. For example:\n\n```\n# First section\nThe content of the first section of your documentation would go here. You can include links, bullets, images, anything!\n\n# Second section\nThis would be the next section.\n\n## You can even use subheadings\nIt will all be formatted correctly, but only the first-level headings will show on the table of contents.\n```\n\n## Adding _huh_ to your theme\nOnce you have your documentation formatted correctly, adding _huh_ to your theme is simple.\n\nJust download the zipped plugin and extract it to your theme directory. At the bottom of your theme's `functions.php` file add the following lines:\n\n``` php\nrequire get_stylesheet_directory() . '/huh/huh.php';\nfunction secretpizzaparty_huh() {\n\t// Enter the URL of your markdown file below\n\t$markdown_url = 'https://raw.githubusercontent.com/secretpizzaparty/huh/master/README.md';\n\t$huh = new WP_Huh();\n\t$huh-\u003einit( $markdown_url );\n}\nadd_action( 'admin_init', 'secretpizzaparty_huh' );\n```\n\nMake sure you change the URL of the `$markdown_url` variable to point to your markdown file. It's that easy!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsecretpizzaparty%2Fhuh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsecretpizzaparty%2Fhuh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsecretpizzaparty%2Fhuh/lists"}