https://github.com/scalameta/metabrowse

Static site generator for code search with IDE features for Scala
https://github.com/scalameta/metabrowse

documentation metaprogramming scala xref

Last synced: 24 days ago
JSON representation

Static site generator for code search with IDE features for Scala

• Host: GitHub
• URL: https://github.com/scalameta/metabrowse
• Owner: scalameta
• License: apache-2.0
• Created: 2017-05-19T07:55:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-08T00:33:32.000Z (8 months ago)
• Last Synced: 2024-04-13T23:55:31.884Z (7 months ago)
• Topics: documentation, metaprogramming, scala, xref
• Language: Scala
• Homepage: https://scalameta.org/metabrowse/#/scalafix/scalafix-core/src/main/scala/scalafix/patch/Patch.scala
• Size: 8.73 MB
• Stars: 104
• Watchers: 9
• Forks: 26
• Open Issues: 28
• Metadata Files:
  • Readme: readme.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Metabrowse

[![Build Status](https://travis-ci.org/scalameta/metabrowse.svg?branch=master)](https://travis-ci.org/scalameta/metabrowse)

[![Join the chat at https://gitter.im/scalameta/scalameta](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/scalameta/metabrowse)

An experiment with [Scalameta Semantic API](http://scalameta.org/tutorial/#SemanticAPI)

to build online code browser with IDE-like features such as "jump to definition" and "find usages".

See our [demo](http://scalameta.org/metabrowse/) page to try it out!

## Implemented features

- Generates a static site that is possible to serve via GitHub pages

- Jump to definition

- Find usages

- Search by symbol

For other features on the roadmap, see our issue tracker: https://github.com/scalameta/metabrowse/issues

## Related projects

- sxr: https://github.com/sbt/sxr/

## Contributing

See the [contribution guide](CONTRIBUTING.md).

## Team

The current maintainers (people who can merge pull requests) are:

* Jonas Fonseca - [`@jonas`](https://github.com/jonas)

* Ólafur Páll Geirsson - [`@olafurpg`](https://github.com/olafurpg)

An up-to-date list of contributors is available here: https://github.com/scalameta/metabrowse/graphs/contributors.

## License

Copyright 2017-2018 Ólafur Páll Geirsson and Jonas Fonseca

Licensed under the Apache License, Version 2.0 (the "License"); you may not use

this file except in compliance with the License. You may obtain a copy of the

License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed

under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR

CONDITIONS OF ANY KIND, either express or implied. See the License for the

specific language governing permissions and limitations under the License.  ```