Comments (7)
Oh this looks pretty excellent!
- I was thinking perhaps something in the top nav bar? Getting functionality in first, and styling it later might be the most efficient way to approach it.
- Uehhh, see 1?
- Probably all the text in the docs?
I'm pretty excited about this! - it probably doesn't work offline, right? - but then.. that probably doesn't matter too much?
from website.
Perfect! You can update it later on
Congratulations, your search is now ready!
I've successfully configured the underlying crawler and it will now run every 24h.
You're now a few steps away from having it working on your website:
- Copy the following CSS/JS snippets and add them to your page
<!-- at the end of the HEAD -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<!-- at the end of the BODY -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
apiKey: '87f0d96cbd5365099c978ede57cc22f5',
indexName: 'choo',
inputSelector: '### REPLACE ME ####',
debug: false // Set debug to true if you want to inspect the dropdown
});
</script>
- Add a search input if you don't have any yet, and update the inputSelector value in the code snippet to a CSS selector that targets your input field.
- Optionally customize the look and feel by following the DocSearch documentation
- You can also check your configuration in the github repo. Feel free to open pull requests!
Feel free to get back to us if you have any issues or questions regarding the integration.
We'd also be happy to get your feedback and thoughts about DocSearch - so we can continue to improve it.
Have a nice day :)
NB: In your email
NB2: Berlin ist wunderbar
from website.
Please let us know what you would like to have and once it is done, just submit one of your link her
I will provide you the JS snippet to integrate within your website.
TY @Haroenv
from website.
Nope, it's doing a request per character, there's not really a way to make a great search offline available unless you'd have a whole search engine on your computer.
What urls are that then, https://choo.io/reference/*, https://handbook.choo.io too?
from website.
@Haroenv yeah, /reference
should be enough. Currently moving to /docs
as per #59 - but it should already be indexable.
Was thinking we move handbook.choo.io
to choo.io/guides/your-first-choo-app
or something, so no need to index it!
from website.
@s-pace thanks heaps!
@Haroenv you willing to pick it back up from here?
from website.
Seems like something went wrong with Zepto (a dependency of DocSearch), where it can't list data of input events for some reason. I don't have the bandwidth currently to make a new version of DocSearch which doesn't depend on Zepto unfortunately (there's a PR for that issue, but not much noise madrobby/zepto#1319).
I also am not too sure how to initialise docsearch after I made the dom node, should I render a script element?
docsearch({
apiKey: '87f0d96cbd5365099c978ede57cc22f5',
indexName: 'choo',
inputSelector: '#docsearch',
});
See my quick work at Haroenv@479d567
For the styling I guess I'll need to do sheetify
with the css from node_modules
from website.
Related Issues (20)
- Not loading fonts or favicon HOT 2
- bug(beacon): Uncaught DOMException HOT 2
- bug: letter spacing renders differently on dev & prod HOT 2
- delete publish script? HOT 1
- mention root node types
- explain programmatic navigation from within stores
- Fix page zoom HOT 1
- main page potentially seizure inducing HOT 4
- explain how to link state machines to user interfaces
- comments in code snippets are difficult to read HOT 1
- Fontsize comparison with Medium (for reference) HOT 2
- document choo/html/raw
- Show how to make components HOT 1
- Server rendering
- State Machine Docs: Syntax Error in Example HOT 2
- Add live example
- Full section about file uploading?
- Part about 'popState' is outdated
- VHS flicker is painful, possibly harmful HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from website.