Git Product home page Git Product logo

Comments (6)

marcoceppi avatar marcoceppi commented on June 20, 2024

Now that we're building docs statically, we can do this. The question is where to get the source of the page title. Should it just be what's in the Navigation sidebar?

from docs.

JoshStrobl avatar JoshStrobl commented on June 20, 2024

Considering we have fairly concise explanations of the purpose of the document as a "header 1" at the top of the markdown docs (example: # Charm configuration in authors-charm-config.md), maybe we can grab that and set it as the <title> content during build.

I think we should stray away from dynamically setting the page title in JavaScript (I don't think that would be beneficial since I doubt indexers wait until dynamic changes are made, rather they just fetch it in the current static state without JavaScript execution), but I'd be 100% happy to quickly change the main.js file to set the page title to the `article h1 content if nobody objects to that or offers up a better idea :D

from docs.

mitechie avatar mitechie commented on June 20, 2024

We do this in the build we're working on at jujucharms.com. You can see an example on the QA site.

http://qa.storefront.theblues.io:6543/docs/config-aws

At some point next week this should be up and working.

from docs.

JoshStrobl avatar JoshStrobl commented on June 20, 2024

That is good to hear. I definitely think it'll make managing having multiple Juju documentation tabs open at once a lot easier.

from docs.

evilnick avatar evilnick commented on June 20, 2024

Just FYI, when we move to the new build tool the docs titles will be set
from metadata.
On Nov 14, 2014 2:11 AM, "Joshua Strobl" [email protected] wrote:

That is good to hear. I definitely think it'll make managing having
multiple Juju documentation tabs open at once a lot easier.


Reply to this email directly or view it on GitHub
#81 (comment).

from docs.

evilnick avatar evilnick commented on June 20, 2024

I'm closing this - not all pages have been given metadata yet, but where it exists it is used, and where it doesn't the website reverts to using the initial heading, which works well

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.