Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the search feature configurable and toggleable #467

Merged
merged 17 commits into from
May 29, 2022
Merged

Make the search feature configurable and toggleable #467

Changes from 2 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
9fa8789
Uncomment line causing tests to fail
caendesilva May 29, 2022
d31794b
Create feature for documentation search
caendesilva May 29, 2022
97b57ca
Set default features
caendesilva May 29, 2022
615a16a
Only enable doc search when doc pages are enabled
caendesilva May 29, 2022
1a257e7
Add the search feature to config array
caendesilva May 29, 2022
622b269
Extract page generation to helper
caendesilva May 29, 2022
ffe5a93
Add todos
caendesilva May 29, 2022
1cfeedb
Run the search index builder when enabled
caendesilva May 29, 2022
b044e4d
Guesstimate generation time
caendesilva May 29, 2022
004d39d
Round guesstimate to no decimals
caendesilva May 29, 2022
340a990
Only add search component when enabled
caendesilva May 29, 2022
f3c3ca5
Document the new search feature
caendesilva May 29, 2022
8821a1d
Add "hidden" config option to disable search page
caendesilva May 29, 2022
b53585b
Improve wording
caendesilva May 29, 2022
6905196
Apply fixes from StyleCI
StyleCIBot May 29, 2022
0499cb0
Merge pull request #466 from hydephp/analysis-yrDgO2
May 29, 2022
dce89ce
Merge branch 'master' into 447-add-simple-optional-search-feature-to-…
caendesilva May 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions src/Commands/HydeBuildSearchCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use Hyde\Framework\Models\DocumentationPage;
use Hyde\Framework\Services\CollectionService;
use LaravelZero\Framework\Commands\Command;
use Symfony\Component\Console\Helper\ProgressBar;

/**
* Hyde Command to run the Build Process for the DocumentationSearchIndex.
Expand Down Expand Up @@ -42,16 +41,16 @@ public function handle(): int
$actionTime = microtime(true);

$this->comment('Generating documentation site search index...');
$this->line('<fg=gray> > This will take an estimated ' . round($this->guesstimateGenerationTime() / 1000) . ' seconds. Terminal may seem non-responsive.</>');
$this->line('<fg=gray> > This will take an estimated '.round($this->guesstimateGenerationTime() / 1000).' seconds. Terminal may seem non-responsive.</>');
GeneratesDocumentationSearchIndexFile::run();

$this->line(' > Created <info>'.GeneratesDocumentationSearchIndexFile::$filePath.'</> in '.
$this->getExecutionTimeInMs($actionTime)."ms\n");

if (config('docs.create_search_page', true)) {
$this->createSearchPage();
}

return 0;
}

Expand Down