Skip to content

Commit 788f0a9

Browse files
committed
docs: add docs box to wp-admin
1 parent 5f5a2be commit 788f0a9

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

plugins/hwp-previews/assets/css/hwp-previews.css

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,18 @@
5656
visibility: visible;
5757
opacity: 1;
5858
}
59+
60+
.hwp-previews-docs ul li {
61+
list-style-type: none;
62+
margin-left: 30px;
63+
padding-bottom: 16px;
64+
}
65+
66+
.hwp-previews-docs ul li:before {
67+
content: url(../icons/doc.svg);
68+
height: 1em;
69+
margin-left: -29px;
70+
margin-top: -2px;
71+
position: absolute;
72+
width: 0.5em;
73+
}
Lines changed: 3 additions & 0 deletions
Loading

plugins/hwp-previews/src/Admin/Settings/Templates/settings-page-main.php

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
declare(strict_types=1);
44

5+
use HWP\Previews\Integration\Faust_Integration;
6+
57
$hwp_previews_tabs_config = (array) get_query_var( 'hwp_previews_main_page_config' );
68
$hwp_previews_current_tab = (string) ( $hwp_previews_tabs_config['current_tab'] ?? '' );
79
$hwp_previews_tabs = (array) ( $hwp_previews_tabs_config['tabs'] ?? [] );
@@ -55,6 +57,23 @@
5557
</div>
5658
</div>
5759
</div>
60+
61+
<div class="postbox">
62+
<h2><?php esc_html_e( 'Get Started With HWP Previews', 'hwp-previews' ); ?></h2>
63+
<div class="inside hwp-previews-docs">
64+
65+
<ul>
66+
<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#getting-started" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Getting Started', 'hwp-previews' ); ?></a></li>
67+
<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#front-end-integration" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Front-End Integration', 'hwp-previews' ); ?></a></li>
68+
<?php if ( Faust_Integration::$faust_enabled ) : ?>
69+
<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#using-with-faustjs" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Using With Faust.js', 'hwp-previews' ); ?></a></li>
70+
<?php endif; ?>
71+
<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#xtending-the-functionality" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Extending the Functionality', 'hwp-previews' ); ?></a></li>
72+
</ul>
73+
<p><?php esc_html_e( 'HWP Previews is part of the HWP Toolkit, our comprehensive suite of tools and examples for headless WordPress.', 'hwp-previews' ); ?></p>
74+
<p><a class="button-secondary" href="https://github.com/wpengine/hwptoolkit" target="_blank" rel="noopener noreferrer">HWP Toolkit on GitHub</a></p>
75+
</div>
76+
</div>
5877
</div>
5978
</div>
6079
</div>

0 commit comments

Comments
 (0)