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.

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

2.x Package Documentation Support #46

Draft
wants to merge 66 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 56 commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
3dfa165
Start scaffolding for documentation area
mbabker Nov 18, 2017
aae7dbe
Add flag tracking explicitly if a package has a major version branch
mbabker Nov 24, 2017
8d4ab80
Routing for package docs
mbabker Nov 24, 2017
8d9c68a
Set internal format on routing, make sure cached class exists
mbabker Nov 24, 2017
a91afc3
Merge branch 'master' into package-docs
mbabker Dec 2, 2017
9ab6fe4
Merge branch 'master' into package-docs
mbabker Jan 6, 2018
372be0c
Add latest version alias, fix routing from docs index
mbabker Jan 6, 2018
0253aeb
Redirect from page controller too
mbabker Jan 6, 2018
2f293ad
Pull filename from request
mbabker Jan 6, 2018
d908e1f
Add to model sort method
mbabker Jan 6, 2018
130c8b6
Add an error HTML view for the documentation section, use it when doc…
mbabker Jan 6, 2018
b94731e
Rendering on docs page controller
mbabker Jan 6, 2018
a687799
Merge branch 'master' into package-docs
mbabker Feb 21, 2018
8c25624
Create command to pull package docs
mbabker Feb 21, 2018
1c25f48
Add infrastructure for a single documentation page
mbabker Feb 21, 2018
732331a
Cache support
mbabker Feb 21, 2018
bdc2c15
Render markdown to HTML
mbabker Feb 21, 2018
bcb65e4
Code syntax highlighting
mbabker Feb 21, 2018
0a4b831
Preload has no v1
mbabker Feb 21, 2018
b968a8f
Comment
mbabker Feb 21, 2018
e141740
Change .md links so site nav works
mbabker Feb 21, 2018
110171b
Add package sidebar
mbabker Feb 21, 2018
90c5f87
Default to a separate sub-dir
mbabker Feb 23, 2018
4e5ed4c
More link tweaking so site nav works
mbabker Feb 23, 2018
f89ef70
Clean rendered cache when fetching files
mbabker Feb 23, 2018
8767005
Cache clear command
mbabker Feb 23, 2018
87904e2
Debug bar integration for HTTP package
mbabker Feb 23, 2018
62e567f
Different message if package doesn't have 1.x release
mbabker Feb 23, 2018
6bcd360
This needs to be else
mbabker Feb 23, 2018
6877e83
Add another breakpoint for the sidebar since some of the text gets a …
mbabker Feb 23, 2018
ebe8de8
Merge branch 'master' into package-docs
mbabker Apr 8, 2018
a54d8ba
Update router use
mbabker Apr 8, 2018
71c6a84
Merge branch 'master' into package-docs
mbabker Apr 29, 2018
0fbd7d5
Add some code related CSS back in
mbabker Apr 29, 2018
9488f2f
Merge branch 'master' into package-docs
mbabker Jun 23, 2018
16ab062
Merge branch 'master' into package-documentation (NOTE: this is witho…
mbabker Feb 14, 2019
f14f5ec
Merge branch 'master' into package-documentation
mbabker Mar 3, 2019
7c54ca1
Re-sync NPM deps and compile assets
mbabker Mar 3, 2019
c302320
Composer update
mbabker Mar 3, 2019
fd8f871
Fix command classes
mbabker Mar 3, 2019
309ee7c
Re-sync SRI
mbabker Mar 3, 2019
1e91234
Fix controller references
mbabker Mar 3, 2019
f734af3
Switch to the Symfony cache component
mbabker Mar 3, 2019
c7b89a6
Add a debug cache adapter and log cache calls to the timeline
mbabker Mar 3, 2019
60a1624
Run PHP-CS-Fixer
mbabker Mar 3, 2019
bf4a50d
Merge branch 'master' into package-documentation
mbabker Oct 7, 2019
0f545e2
Vendor update (re-gen lock from master merge)
mbabker Oct 7, 2019
a71612c
Fix PHP 7.3 warning
mbabker Oct 7, 2019
dac417f
NPM update (re-gen lock from master merge), regenerate assets
mbabker Oct 7, 2019
6229c0f
Fix class name
mbabker Oct 7, 2019
d26fc43
Undefined var
mbabker Oct 7, 2019
faab916
Lost clear cache command in loader
mbabker Oct 7, 2019
0765144
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
Hackwar Aug 23, 2022
7365848
Fixing previous merge
Hackwar Aug 23, 2022
60f3c3e
Fixing codestyle
Hackwar Aug 23, 2022
79c0a04
Cleanup
Hackwar Aug 23, 2022
40bf5ec
More codestyle
Hackwar Aug 23, 2022
9cd9750
Last codestyle fixes
Hackwar Aug 23, 2022
13921cd
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
Hackwar Aug 26, 2022
8a9e8c0
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
Hackwar Feb 3, 2023
7ea048e
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
Hackwar Feb 3, 2023
7f9c414
Updating assets
Hackwar Feb 3, 2023
8c9f138
Updating dependencies, adding 3.x versions/branches
Hackwar Feb 4, 2023
873aa98
Adding current version per branch to status page
Hackwar Feb 4, 2023
babbdd5
Codestyle
Hackwar Feb 4, 2023
817cafa
Some cleanup
Hackwar Feb 4, 2023
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/cache/*
!/cache/.placeholder

# App Docs #
# Documentation Cache #
/docs/*
!/docs/.placeholder

Expand Down
65 changes: 64 additions & 1 deletion assets/scss/_global.scss
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ a {
position: relative;
}

nav {
nav.main-nav {
background-color: $darker-black;
color: #ffffff;
padding: .5rem 0;
Expand Down Expand Up @@ -99,3 +99,66 @@ footer {
color: theme-color("primary");
}
}

.sidenav-body {
display: flex;
flex-wrap: wrap;
justify-content: space-around;
.sidebar {
flex-basis: 100%;
@include media-breakpoint-up(md) {
flex-basis: calc(30% - 1vw);
}
@include media-breakpoint-up(lg) {
flex-basis: calc(25% - 1vw);
}
@include media-breakpoint-up(xl) {
flex-basis: calc(20% - 1vw);
}
}
.content {
flex-basis: 100%;
@include media-breakpoint-up(md) {
flex-basis: calc(70% - 1vw);
}
@include media-breakpoint-up(lg) {
flex-basis: calc(75% - 1vw);
}
@include media-breakpoint-up(xl) {
flex-basis: calc(80% - 1vw);
}
}
@supports (display: grid) {
display: grid;
grid-template-columns: 1fr;
grid-gap: 1.25rem;
@include media-breakpoint-up(md) {
grid-template-columns: 30% 70%;
}
@include media-breakpoint-up(lg) {
grid-template-columns: 25% 75%;
}
@include media-breakpoint-up(xl) {
grid-template-columns: 20% 80%;
}
.sidebar {
order: 2;
@include media-breakpoint-up(md) {
order: 1;
}
}
.content {
order: 1;
@include media-breakpoint-up(md) {
order: 2;
}
}
}
}

.highlight {
pre {
font-family: "SFMono-Regular",Consolas,"Liberation Mono",Menlo,Courier,monospace;
@extend .bg-light;
}
}
2 changes: 2 additions & 0 deletions assets/scss/code.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Import the theme, customize as necessary afterwards
@import "~github-syntax-light/lib/github-light.css";
13 changes: 13 additions & 0 deletions assets/scss/pages/_homepage.scss
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
nav.homepage {
ul {
li {
margin-left: 5%;
@include media-breakpoint-up(md) {
margin-left: 1%;
}
@include media-breakpoint-up(lg) {
margin-left: 3%;
}
@include media-breakpoint-up(xl) {
margin-left: 4%;
}
&:first-child {
margin-left: 0;
}
span {
&.title {
display: none;
Expand Down
1 change: 1 addition & 0 deletions bin/framework
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ try
{
$container = (new Joomla\DI\Container)
->registerServiceProvider(new Joomla\FrameworkWebsite\Service\ApplicationProvider)
->registerServiceProvider(new Joomla\FrameworkWebsite\Service\CacheProvider)
->registerServiceProvider(new Joomla\FrameworkWebsite\Service\ConfigurationProvider(JPATH_ROOT . '/etc/config.json'))
->registerServiceProvider(new Joomla\Database\Service\DatabaseProvider)
->registerServiceProvider(new Joomla\FrameworkWebsite\Service\EventProvider)
Expand Down
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"ramsey/uuid": "^4.0.1",
"robmorgan/phinx": "^0.12.3",
"symfony/asset": "^5.1.2",
"symfony/cache": "^5.1.2",
"symfony/process": "^5.1.2",
"symfony/web-link": "^5.1.2",
"symfony/yaml": "^5.1.2",
Expand Down
Loading