Skip to content
This repository was archived by the owner on Feb 16, 2019. It is now read-only.

Conversation

@dazz
Copy link

@dazz dazz commented May 26, 2013

Added twitter bootstrap theme to Sami

@blaugueux
Copy link

+1

2 similar comments
@GrahamCampbell
Copy link
Contributor

+1

@wibimaster
Copy link

+1

@lyrixx
Copy link
Member

lyrixx commented Jun 5, 2014

Can you paste a screen shot? Thanks

@aik099
Copy link
Contributor

aik099 commented Jun 27, 2014

👍 for screenshot.

@mtdowling
Copy link
Contributor

I just checked this out, rebased on master, and built the docs for a project of mine. The output looks like it might not be up to date with recent changes to Sami. For example, method documentation is pretty broken.

screen shot 2014-08-22 at 5 08 40 pm

Also notice that, along with Sami's default theme, the navigation frame does not work on my localhost.

@aik099
Copy link
Contributor

aik099 commented Aug 23, 2014

Can you also attach default there for same code piece?

@aik099
Copy link
Contributor

aik099 commented Aug 23, 2014

For example, method documentation is pretty broken.

If you can please fix any theme issues.

@fabpot
Copy link
Member

fabpot commented Aug 28, 2014

closing in favor of #124

@fabpot fabpot closed this Aug 28, 2014
fabpot added a commit that referenced this pull request Oct 23, 2014
…es (mtdowling)

This PR was squashed before being merged into the 2.0-dev branch (closes #124).

Discussion
----------

Adding a theme based on twitter bootstrap not using frames

This commit adds a bootstrap 3 powered theme to Sami that does not use frames.

Closes #119, #122, #47, #13, #123.

This pull request adds a new theme that is completely rewritten to be simpler, not use frames, and is now responsive (i.e., looks good on a phone). I've re-implemented the left-navigation using a much simpler approach, created a new search implementation that allows users to hook in custom search result types by extending the theme, and added breadcrumbs. I tried to keep a relatively similar look and feel to the existing Sami theme, but with a bit of twitter bootstrap on top.

Because this provides the same features of the default theme and includes additional features, I would recommend making this the default theme and removing the "enhanced" theme. If you'd like me to do this, then let me know and I'll rebase with those changes.

Here are some screenshots and descriptions of what they do.

Namespaces
----

This is the namespaces page. It just lists each namespace. This is also the homepage if a project has classes.

![screen shot 2014-08-27 at 9 05 35 pm](https://cloud.githubusercontent.com/assets/190930/4071023/99ca9ca0-2e68-11e4-99f4-b3a4a23e3315.png)

Here is is at a smaller width:

![screen shot 2014-08-27 at 9 17 16 pm](https://cloud.githubusercontent.com/assets/190930/4071119/3bb59f82-2e6a-11e4-9943-c0319ebe1636.png)

Note: the button at the top provides a drop down containing the menu.

Classes
-----

Here is the "classes" page, full-screen.

![screen shot 2014-08-27 at 9 08 02 pm](https://cloud.githubusercontent.com/assets/190930/4071038/eb77dfb8-2e68-11e4-8f40-14e46534d95b.png)

And again, small screen:

![screen shot 2014-08-27 at 9 08 19 pm](https://cloud.githubusercontent.com/assets/190930/4071041/fc6b8644-2e68-11e4-8ea0-7c640aacc014.png)

Note: Traits, and interfaces look that same as this page.

Index page (doc-index)
----

![screen shot 2014-08-27 at 9 09 12 pm](https://cloud.githubusercontent.com/assets/190930/4071049/1d782572-2e69-11e4-9a42-52043d7d450d.png)

This looks good on a phone too:

![screen shot 2014-08-27 at 9 09 53 pm](https://cloud.githubusercontent.com/assets/190930/4071055/3373766a-2e69-11e4-890f-d6f6c86ac3d0.png)

Interface
----

Here's an interface page. Just like with class and namespace pages, the left-nav is scrolled down to show the currently selected node.

![screen shot 2014-08-27 at 9 10 35 pm](https://cloud.githubusercontent.com/assets/190930/4071062/5fb33e54-2e69-11e4-8d04-22e37aae2a16.png)

Here are the start of the methods:

![screen shot 2014-08-27 at 9 11 36 pm](https://cloud.githubusercontent.com/assets/190930/4071065/6c724338-2e69-11e4-8f36-84a031e336c7.png)

Namespace page
----

Here's a namespace page. It lists the sub-namespaces, the classes, traits, interfaces, etc.

![screen shot 2014-08-27 at 9 12 02 pm](https://cloud.githubusercontent.com/assets/190930/4071068/8d4a8c46-2e69-11e4-953c-4df5fa23ba55.png)

Search page
-----

When you submit a search query, it takes you to this page.

![screen shot 2014-08-27 at 9 12 57 pm](https://cloud.githubusercontent.com/assets/190930/4071078/a481571e-2e69-11e4-80a6-b02d2d923474.png)

The search looks through the names of each thing in the search index. The search index contains each namespace, class, interface, trait, and methods from each of these.

Commits
-------

91a2bf8 Adding a theme based on twitter bootstrap not using frames
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants