mirror of
https://github.com/10h30/ultimatemember.git
synced 2026-06-05 15:09:37 +09:00
- added docs generator;
This commit is contained in:
Mykyta Synelnikov
@@ -0,0 +1,7 @@
|
||||
# Welcome to the Ultimate Member Plugin Hook Documentation
|
||||
|
||||
This resource is generated documentation on actions and filters found in the [Ultimate Member](https://wordpress.org/plugins/ultimate-member/) plugin. Use the sidebar to browse and navigate.
|
||||
|
||||
For more information about using Ultimate Member with WordPress, please see the [Ultimate Member Docs](https://docs.ultimatemember.com/).
|
||||
|
||||
To report an issue with Ultimate Member, please visit the [Support forum](https://wordpress.org/support/plugin/ultimate-member/).
|
||||
@@ -0,0 +1,46 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title><?js= title ?> - Ultimate Member Hook Docs</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"> </script>
|
||||
<script src="scripts/prettify/lang-css.js"> </script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
|
||||
<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Mono|IBM+Plex+Sans:300,400|Playfair+Display:900&display=swap" rel="stylesheet">
|
||||
<link type="text/css" rel="stylesheet" href="styles-um.css">
|
||||
</head>
|
||||
|
||||
<body<?js if (title === 'Home') { ?> class="home"<?js } ?>>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<?js if (title !== 'Home') { ?>
|
||||
<h1 class="page-title"><?js= title ?></h1>
|
||||
<?js } ?>
|
||||
|
||||
<?js= content ?>
|
||||
|
||||
<footer>
|
||||
<a href="https://wordpress.org/plugins/ultimate-member/">Ultimate Member Plugin</a> •
|
||||
<a href="https://docs.ultimatemember.com/">Official Docs</a>
|
||||
</footer>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<nav>
|
||||
<?js= this.nav ?>
|
||||
</nav>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
<script src="scripts/linenumber.js"> </script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,98 @@
|
||||
body {
|
||||
background: #fefefe;
|
||||
color: #232323;
|
||||
font-family: 'IBM Plex Sans', sans-serif;
|
||||
font-size: 1.3rem;
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
line-height: 1.2;
|
||||
font-family: 'Playfair Display', sans-serif;
|
||||
font-weight: 900;
|
||||
letter-spacing: -.01em;
|
||||
}
|
||||
|
||||
h1.page-title {
|
||||
font-size: 42px;
|
||||
margin-top: .5em;
|
||||
}
|
||||
|
||||
nav ul {
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
|
||||
nav li a {
|
||||
background-image: none;
|
||||
}
|
||||
|
||||
nav li a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
code, pre,
|
||||
nav ul a, nav ul a:visited, nav ul a:active,
|
||||
.name, .signature,
|
||||
.params .name, .props .name,
|
||||
.name code {
|
||||
font-family: 'IBM Plex Mono', monospace;
|
||||
}
|
||||
|
||||
article h1 {
|
||||
margin: 12px 0 32px;
|
||||
}
|
||||
|
||||
a {
|
||||
background-image: linear-gradient(transparent calc(100% - 7px), #f2dede 0),
|
||||
linear-gradient(transparent calc(100% - 7px), #cef8f7 0);
|
||||
background-position: 0 0;
|
||||
background-repeat: no-repeat;
|
||||
background-size: 0 100%, 100% 100%;
|
||||
color: #232323;
|
||||
text-decoration: none;
|
||||
transition: all .1s;
|
||||
}
|
||||
|
||||
a:visited,
|
||||
a:active {
|
||||
color: #232323;
|
||||
}
|
||||
|
||||
a:focus,
|
||||
a:hover {
|
||||
background-size: 100% 100%, 100% 100%;
|
||||
color: #232323;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.banner {
|
||||
background-image: none;
|
||||
margin-left: -10px;
|
||||
}
|
||||
|
||||
a.banner img {
|
||||
width: 100%;
|
||||
max-width: 888px;
|
||||
}
|
||||
|
||||
footer {
|
||||
text-align: center;
|
||||
font-size: .8em;
|
||||
font-style: normal;
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
.home #main > section:first-of-type,
|
||||
.home nav > h2 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.prettyprint.source {
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
.prettyprint code {
|
||||
padding: 2px 10px;
|
||||
line-height: 16px;
|
||||
height: 16px;
|
||||
}
|
||||
+7
-1
@@ -6,6 +6,12 @@
|
||||
"license": "GPL-3.0-or-later",
|
||||
"minimum-stability": "stable",
|
||||
"prefer-stable": true,
|
||||
"config": {
|
||||
"allow-plugins": {
|
||||
"symfony/flex": true,
|
||||
"dealerdirect/phpcodesniffer-composer-installer": true
|
||||
}
|
||||
},
|
||||
"require": {
|
||||
"ext-mbstring": "*",
|
||||
"ext-json": "*",
|
||||
@@ -18,7 +24,7 @@
|
||||
"woocommerce/action-scheduler": "3.2.1"
|
||||
},
|
||||
"require-dev": {
|
||||
"roave/security-advisories": "dev-master",
|
||||
"roave/security-advisories": "dev-latest",
|
||||
"wp-cli/wp-cli": "*",
|
||||
"dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
|
||||
"object-calisthenics/phpcs-calisthenics-rules": "*",
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"opts": {
|
||||
"destination": "docs/hooks",
|
||||
"template": "node_modules/wp-hookdoc/template",
|
||||
"recurse": true,
|
||||
"readme": "./.github/hookdoc-tmpl/README.md"
|
||||
},
|
||||
"source": {
|
||||
"include": [
|
||||
"./"
|
||||
],
|
||||
"exclude": [
|
||||
"node_modules"
|
||||
],
|
||||
"includePattern": ".+\\.(php)?$"
|
||||
},
|
||||
"plugins": [
|
||||
"node_modules/wp-hookdoc/plugin",
|
||||
"plugins/markdown"
|
||||
],
|
||||
"templates": {
|
||||
"default": {
|
||||
"layoutFile": "./.github/hookdoc-tmpl/layout.tmpl",
|
||||
"staticFiles": {
|
||||
"include": [
|
||||
"./.github/hookdoc-tmpl/static"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+12
-5
@@ -1,7 +1,11 @@
|
||||
{
|
||||
"name": "roots",
|
||||
"version": "7.0.3",
|
||||
"author": "Ben Word <ben@benword.com>",
|
||||
"name": "ultimate-member",
|
||||
"version": "2.6.3",
|
||||
"author": {
|
||||
"name": "Ultimate Member",
|
||||
"email": "team@ultimatemember.com",
|
||||
"url": "https://ultimatemember.com"
|
||||
},
|
||||
"homepage": "http://roots.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -17,7 +21,7 @@
|
||||
}
|
||||
],
|
||||
"scripts": {
|
||||
"postinstall": "node node_modules/bower/bin/bower install && grunt dev",
|
||||
"build:docs": "rm -rf docs/hooks/ && jsdoc -c hookdoc-conf.json",
|
||||
"build": "npm-run-all build:*",
|
||||
"build:all-blocks": "npm-run-all --parallel build-block-*",
|
||||
"build-block-um-member-directories": "cd includes/blocks/um-member-directories && wp-scripts build src/index.js",
|
||||
@@ -36,6 +40,8 @@
|
||||
"gulp-sass": "^5.1.0",
|
||||
"gulp-uglify": "^3.0.2",
|
||||
"gulp-clean-css": "^4.3.0",
|
||||
"jsdoc": "~4.0.2",
|
||||
"wp-hookdoc": "^0.2.0",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"@wordpress/block-editor": "^11.5.0",
|
||||
"@wordpress/blocks": "^12.5.0",
|
||||
@@ -45,6 +51,7 @@
|
||||
"@wordpress/server-side-render": "^4.5.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"react": "^18.2.0"
|
||||
"react": "^18.2.0",
|
||||
"taffydb": "^2.7.3"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<phpdocumentor
|
||||
configVersion="3"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns="https://www.phpdoc.org"
|
||||
xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd">
|
||||
<title>Ultimate Member - PHPDoc</title>
|
||||
<paths>
|
||||
<output>docs/phpdoc</output>
|
||||
<cache>docs/phpdoc/cache</cache>
|
||||
</paths>
|
||||
<version number="1.0.0">
|
||||
<folder>latest</folder>
|
||||
<api>
|
||||
<source dsn=".">
|
||||
<path>includes</path>
|
||||
<path>templates</path>
|
||||
</source>
|
||||
<extensions>
|
||||
<extension>php</extension>
|
||||
</extensions>
|
||||
</api>
|
||||
</version>
|
||||
<template name="clean"/>
|
||||
</phpdocumentor>
|
||||
Reference in New Issue
Block a user